summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMoritz Schulte <mo@g10code.com>2005-11-26 11:52:14 +0000
committerMoritz Schulte <mo@g10code.com>2005-11-26 11:52:14 +0000
commit9d775862110c4aae359c4d8cb3ad506fc1347bc5 (patch)
treeae06435d28cef06003b3281c821354573dc44782 /doc
parentfb5d3c2d0b90f688cb939c8b3535a6666306b52a (diff)
downloadlibgcrypt-9d775862110c4aae359c4d8cb3ad506fc1347bc5.tar.gz
2005-11-12 Moritz Schulte <moritz@g10code.com>
* gcrypt.texi (MPI formats): Document that for gcry_mpi_scan and in the case of GCRYMPI_FMT_HEX, BUFLEN must be zero.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog5
-rw-r--r--doc/gcrypt.texi4
2 files changed, 7 insertions, 2 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 3704ca8e..17d6894d 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2005-11-12 Moritz Schulte <moritz@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@g10code.com>
* gcrypt.texi: Added more gcry_control related descriptions.
diff --git a/doc/gcrypt.texi b/doc/gcrypt.texi
index 88b1965a..0ded92b9 100644
--- a/doc/gcrypt.texi
+++ b/doc/gcrypt.texi
@@ -2544,7 +2544,7 @@ Note, that it is not possible to chek the `saneness' of a public key.
@end deftypefun
-@deftypefun int gcry_pk_algo_info (@w{int @var{algo}}, @w{int @var{what}}, @w{void *@var{buffer}}, @w{size_t *@var{nbytes}})
+@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 @@ with a 4 byte big endian header.
@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.