[svn] gcry - r1406 - trunk/doc

[svn author wk]

Author: wk
Date: 2009-10-28 16:11:40 +0100 (Wed, 28 Oct 2009)
New Revision: 1406

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


Modified: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog	2009-08-21 09:34:39 UTC (rev 1405)
+++ trunk/doc/ChangeLog	2009-10-28 15:11:40 UTC (rev 1406)
@@ -1,3 +1,7 @@
+2009-10-28  Werner Koch  <wk at g10code.com>
+
+	* gcrypt.texi (Multi-Threading): Add examples.
+
 2009-07-02  Daiki Ueno  <ueno at unixuser.org>
 
 	* gcrypt.texi (Working with S-expressions): Describe format

Modified: trunk/doc/gcrypt.texi
===================================================================
--- trunk/doc/gcrypt.texi	2009-08-21 09:34:39 UTC (rev 1405)
+++ trunk/doc/gcrypt.texi	2009-10-28 15:11:40 UTC (rev 1406)
@@ -498,8 +498,13 @@
 
 After including this macro, @code{gcry_control()} shall be used with a
 command of @code{GCRYCTL_SET_THREAD_CBS} in order to register the
-thread callback structure named ``gcry_threads_pth''.
+thread callback structure named ``gcry_threads_pth''.  Example:
 
+ at smallexample
+  ret = gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pth);
+ at end smallexample
+
+
 @item GCRY_THREAD_OPTION_PTHREAD_IMPL
 
 This macro defines the following (static) symbols:
@@ -509,7 +514,13 @@
 
 After including this macro, @code{gcry_control()} shall be used with a
 command of @code{GCRYCTL_SET_THREAD_CBS} in order to register the
-thread callback structure named ``gcry_threads_pthread''.
+thread callback structure named ``gcry_threads_pthread''.  Example:
+
+ at smallexample
+  ret = gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
+ at end smallexample
+
+
 @end table
 
 Note that these macros need to be terminated with a semicolon.  Keep
@@ -589,11 +600,12 @@
 
 @table @code
 @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 initialization time.  Note that
-the memory guard is NOT used when the user of the library has set his
-own memory management callbacks.
+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 before
+ at code{gcry_check_version}.  Note that the memory guard is NOT used
+when the user of the library has set his own memory management
+callbacks.
 
 @item GCRYCTL_ENABLE_QUICK_RANDOM; Arguments: none
 This command inhibits the use the very secure random quality level