[svn] gcry - r1138 - trunk/doc

[svn author mo]

Author: mo
Date: 2005-11-26 12:52:14 +0100 (Sat, 26 Nov 2005)
New Revision: 1138

Modified:
   trunk/doc/ChangeLog
   trunk/doc/gcrypt.texi
Log:
2005-11-12  Moritz Schulte  <moritz at g10code.com>

	* gcrypt.texi (MPI formats): Document that for gcry_mpi_scan and
	in the case of GCRYMPI_FMT_HEX, BUFLEN must be zero.


Modified: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog	2005-11-02 16:54:12 UTC (rev 1137)
+++ trunk/doc/ChangeLog	2005-11-26 11:52:14 UTC (rev 1138)
@@ -1,3 +1,8 @@
+2005-11-12  Moritz Schulte  <moritz at g10code.com>
+
+	* gcrypt.texi (MPI formats): Document that for gcry_mpi_scan and
+	in the case of GCRYMPI_FMT_HEX, BUFLEN must be zero.
+
 2005-10-31  Moritz Schulte  <moritz at g10code.com>
 
 	* gcrypt.texi: Added more gcry_control related descriptions.

Modified: trunk/doc/gcrypt.texi
===================================================================
--- trunk/doc/gcrypt.texi	2005-11-02 16:54:12 UTC (rev 1137)
+++ trunk/doc/gcrypt.texi	2005-11-26 11:52:14 UTC (rev 1138)
@@ -2544,7 +2544,7 @@
 @end deftypefun
 
 
- at deftypefun int gcry_pk_algo_info (@w{int @var{algo}}, @w{int @var{what}}, @w{void *@var{buffer}}, @w{size_t *@var{nbytes}})
+ at deftypefun gcry_error_t gcry_pk_algo_info (@w{int @var{algo}}, @w{int @var{what}}, @w{void *@var{buffer}}, @w{size_t *@var{nbytes}})
 
 Depending on the value of @var{what} return various information about
 the public key algorithm with the id @var{algo}.  Note, that the
@@ -3669,7 +3669,7 @@
 
 @item GCRYMPI_FMT_HEX
 Stored as a C style string with each byte of the MPI encoded as 2 hex
-digits.
+digits.  When using this format, @var{buflen} must be zero.
 
 @item GCRYMPI_FMT_USG
 Simple unsigned integer.