postgres.git / summary / log / commit / refs

commit    8bfc2b1793ae4b27ebc4c8086117a509b4873e37
Author:   Tom Lane <tgl@sss.pgh.pa.us>
Date:     Mon Nov 03 16:11:34 2014 +0000
First released in: 9.5.0, 9.0.19, 9.1.15, 9.2.10, 9.3.6, 9.4.0

    Docs: fix incorrect spelling of contrib/pgcrypto option.
    
    pgp_sym_encrypt's option is spelled "sess-key", not "enable-session-key".
    Spotted by Jeff Janes.
    
    In passing, improve a comment in pgp-pgsql.c to make it clearer that
    the debugging options are intentionally undocumented.


 contrib/pgcrypto/pgp-pgsql.c | 5 ++++-
 doc/src/sgml/pgcrypto.sgml   | 4 ++--
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/contrib/pgcrypto/pgp-pgsql.c b/contrib/pgcrypto/pgp-pgsql.c
index f3185eb3035..ce76e65e25f 100644
--- a/contrib/pgcrypto/pgp-pgsql.c
+++ b/contrib/pgcrypto/pgp-pgsql.c
@@ -260,7 +260,10 @@ set_arg(PGP_Context *ctx, char *key, char *val,
 		res = pgp_set_convert_crlf(ctx, atoi(val));
 	else if (strcmp(key, "unicode-mode") == 0)
 		res = pgp_set_unicode_mode(ctx, atoi(val));
-	/* decrypt debug */
+	/*
+	 * The remaining options are for debugging/testing and are therefore not
+	 * documented in the user-facing docs.
+	 */
 	else if (ex != NULL && strcmp(key, "debug") == 0)
 		ex->debug = atoi(val);
 	else if (ex != NULL && strcmp(key, "expect-cipher-algo") == 0)
diff --git a/doc/src/sgml/pgcrypto.sgml b/doc/src/sgml/pgcrypto.sgml
index c0d14521a42..e8c50385172 100644
--- a/doc/src/sgml/pgcrypto.sgml
+++ b/doc/src/sgml/pgcrypto.sgml
@@ -728,11 +728,11 @@ Applies to: pgp_sym_encrypt, pgp_pub_encrypt
   </sect4>
 
   <sect4>
-   <title>enable-session-key</title>
+   <title>sess-key</title>
 
    <para>
     Use separate session key.  Public-key encryption always uses a separate
-    session key; this is for symmetric-key encryption, which by default
+    session key; this option is for symmetric-key encryption, which by default
     uses the S2K key directly.
    </para>
 <literallayout>


[parent: fcf0246b2c58]