[exim-cvs] gen_pkcs3: add comment explaining rationale

Gitweb: http://git.exim.org/exim.git/commitdiff/c3eacdb0bc1ab24331b781dc3f08b075aa52e329

Commit:     c3eacdb0bc1ab24331b781dc3f08b075aa52e329
Parent:     d36a05018e1ac918951d551450acc53137ecf6e0
Author:     Phil Pennock <pdp@???>
AuthorDate: Sun Dec 23 14:23:01 2012 -0500
Committer:  Phil Pennock <pdp@???>
CommitDate: Sun Dec 23 14:24:05 2012 -0500

    gen_pkcs3: add comment explaining rationale

    Wondering why you wrote some code and having to grep the source code to find out,
    in the same year that you wrote it, is generally a sign of missing information.

    Fixed.
---
 src/util/gen_pkcs3.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/src/util/gen_pkcs3.c b/src/util/gen_pkcs3.c
index ae7e761..4be2c58 100644
--- a/src/util/gen_pkcs3.c
+++ b/src/util/gen_pkcs3.c
@@ -7,6 +7,16 @@
* c99 $(pkg-config --cflags openssl) gen_pkcs3.c $(pkg-config --libs openssl)
*/

+/*
+ * Rationale:
+ * The Diffie-Hellman primes which are embedded into Exim as named primes for
+ * the tls_dhparam option are in the std-crypto.c file. The source for those
+ * comes from various RFCs, where they are given in hexadecimal form.
+ *
+ * This tool provides convenient conversion, to reduce the risk of human
+ * error in transcription.
+ */
+
#include <ctype.h>
#include <errno.h>
#include <stdbool.h>