* gcrypt.texi (Misc): Add a warning on the use of opaque values.
authorWerner Koch <wk@gnupg.org>
Fri, 18 Jul 2003 11:44:42 +0000 (11:44 +0000)
committerWerner Koch <wk@gnupg.org>
Fri, 18 Jul 2003 11:44:42 +0000 (11:44 +0000)
doc/ChangeLog
doc/gcrypt.texi

index b9fd328..6a5fdf1 100644 (file)
@@ -1,3 +1,7 @@
+2003-07-18  Werner Koch  <wk@gnupg.org>
+
+       * gcrypt.texi (Misc): Add a warning on the use of opaque values.
+
 2003-07-14  Moritz Schulte  <moritz@g10code.com>
 
        * gcrypt.texi (Overview): Mention the non-thread-safe-nature of
index cfd78d8..78edd66 100644 (file)
@@ -3245,6 +3245,11 @@ Store @var{nbits} of the value @var{p} points to in @var{a} and mark
 @var{a} as an opaque value (i.e. an value that can't be used for any
 math calculation and is only used to store an arbitrary bit pattern in
 @var{a}.
+
+WARNING: Never use an opaque MPI for actual math operations.  The only
+valid fucntions are gcry_mpi_get_opaque and gcry_mpi_release.  Use
+gcry_mpi_scan to convert a string of arbitrary bytes into an MPI.
+
 @end deftypefun
 
 @deftypefun {void *} gcry_mpi_get_opaque (@w{gcry_mpi_t @var{a}}, @w{unsigned int *@var{nbits}})