From: Mark Wooding <mdw@distorted.org.uk>
Date: Fri, 9 Nov 2018 21:46:56 +0000 (+0000)
Subject: symm/desx.c, symm/desx.h (desx_init): Fix documentation.
X-Git-Tag: 2.4.3~11
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/catacomb/commitdiff_plain/eea8ea584662d55b98c2ac594274870eb9182d04?ds=inline;hp=--cc

symm/desx.c, symm/desx.h (desx_init): Fix documentation.

The two documentation comments disagreed about the orders of the key
pieces.  The implementation had it right: the DES key comes first,
followed by the whitening keys.  Fix the header, and a stupid typo.
---

eea8ea584662d55b98c2ac594274870eb9182d04
diff --git a/symm/desx.c b/symm/desx.c
index e9a77ed9..14115a57 100644
--- a/symm/desx.c
+++ b/symm/desx.c
@@ -61,7 +61,7 @@ const octet desx_keysz[] = { KSZ_SET, 23, 7, 8, 15, 16, 24, 0 };
  * Use:		Initializes a DESX key buffer.  The key buffer contains, in
  *		order, a single-DES key (either 7 or 8 bytes), an optional
  *		8-byte pre-whitening key, and an optional 8-byte
- *		port-whitening key.  If no whitening keys are specified, the
+ *		post-whitening key.  If no whitening keys are specified, the
  *		algorithm becomes the same as single-DES.
  */
 
diff --git a/symm/desx.h b/symm/desx.h
index 62e8300d..005d1c45 100644
--- a/symm/desx.h
+++ b/symm/desx.h
@@ -76,10 +76,10 @@ typedef struct desx_ctx {
  * Returns:	---
  *
  * Use:		Initializes a DESX key buffer.  The key buffer contains, in
- *		order, an optional 8-byte pre-whitening key, a single-DES key
- *		(either 7 or 8 bytes), and an optional 8-byte port-whitening
- *		key.  If no whitening keys are specified, the algorithm
- *		becomes the same as single-DES.
+ *		order, a single-DES key (either 7 or 8 bytes), an optional
+ *		8-byte pre-whitening key, and an optional 8-byte
+ *		post-whitening key.  If no whitening keys are specified, the
+ *		algorithm becomes the same as single-DES.
  */
 
 extern void desx_init(desx_ctx */*k*/, const void */*buf*/, size_t /*sz*/);