[svn] gcry - r1133 - trunk/doc

[svn author mo]

Author: mo
Date: 2005-10-31 22:36:01 +0100 (Mon, 31 Oct 2005)
New Revision: 1133

Modified:
   trunk/doc/ChangeLog
   trunk/doc/gcrypt.texi
Log:
ChangeLog:

2005-10-31  Moritz Schulte  <moritz at g10code.com>

	* gcrypt.texi: Added more gcry_control related descriptions.


Modified: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog	2005-10-31 21:33:46 UTC (rev 1132)
+++ trunk/doc/ChangeLog	2005-10-31 21:36:01 UTC (rev 1133)
@@ -1,3 +1,7 @@
+2005-10-31  Moritz Schulte  <moritz at g10code.com>
+
+	* gcrypt.texi: Added more gcry_control related descriptions.
+
 2005-10-16  Moritz Schulte  <moritz at g10code.com>
 
 	* gcrypt.texi (Controlling the library): Start documenting the

Modified: trunk/doc/gcrypt.texi
===================================================================
--- trunk/doc/gcrypt.texi	2005-10-31 21:33:46 UTC (rev 1132)
+++ trunk/doc/gcrypt.texi	2005-10-31 21:36:01 UTC (rev 1133)
@@ -494,16 +494,33 @@
 @item GCRYCTL_ENABLE_M_GUARD; Arguments: none
 This command enables the built-in memory guard.  It must not be used to
 activate the memory guard after the memory management has already been
-used; therefore it can ONLY be used at initializatoin time.  Note that
+used; therefore it can ONLY be used at initialization time.  Note that
 the memory guard is NOT used when the user of the library has set his
 own memory management callbacks.
 
- at item GCRYCTL_ENABLE_QUICK_RANDOM
+ at item GCRYCTL_ENABLE_QUICK_RANDOM; Arguments: none
+This command activates the use of a highly-insecure, but fast PRNG.  It
+can only be used at initialization time - FIXME: is this correct?
+
 @item GCRYCTL_DUMP_RANDOM_STATS
+This command dumps PRNG related statistics to the librarys logging
+stream.
+
 @item GCRYCTL_DUMP_MEMORY_STATS
+This command dumps memory manamgent related statistics to the librarys
+logging stream.
+
 @item GCRYCTL_DUMP_SECMEM_STATS
+This command dumps secure memory manamgent related statistics to the
+librarys logging stream.
+
 @item GCRYCTL_DROP_PRIVS
+This command disables the use of secure memory and drops the priviliges
+of the current process.  FIXME.
+
 @item GCRYCTL_DISABLE_SECMEM
+This command disables the use of secure memory.  FIXME.
+
 @item GCRYCTL_INIT_SECMEM
 @item GCRYCTL_TERM_SECMEM
 @item GCRYCTL_DISABLE_SECMEM_WARN
@@ -529,8 +546,8 @@
 @section Modules
 
 @acronym{Libgcrypt} supports the use of `extension modules', which
-implement algorithms in addition to those already built into the
-library directly.
+implement algorithms in addition to those already built into the library
+directly.
 
 @deftp {Data type} gcry_module_t
 This data type represents a `module'.