summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2011-06-02 23:20:12 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2011-06-02 23:23:06 +0200
commitdd6b66f6eebb155cf5ef086f5d6f1c24a6261603 (patch)
treeac5a947607be68c6cd19f7fc698ac1f22d22144d
parent82ad8cac4b23990bef76be1de4e0a1740b59241c (diff)
downloadgnutls-dd6b66f6eebb155cf5ef086f5d6f1c24a6261603.tar.gz
Added refint macro to refer to internal -non exported- functions. Used it to reference to the gnutls_*_register() functions.
-rw-r--r--doc/cha-internals.texi14
-rw-r--r--doc/gnutls.texi5
2 files changed, 12 insertions, 7 deletions
diff --git a/doc/cha-internals.texi b/doc/cha-internals.texi
index 998177884f..0180003683 100644
--- a/doc/cha-internals.texi
+++ b/doc/cha-internals.texi
@@ -377,10 +377,10 @@ following functions can be used to register those algorithms.
@itemize
-@item @ref{gnutls_crypto_single_cipher_register2}
+@item @refint{gnutls_crypto_single_cipher_register}
To register a cipher algorithm.
-@ref{gnutls_crypto_single_digest_register2}
+@refint{gnutls_crypto_single_digest_register}
To register a hash (digest) or MAC algorithm.
@end itemize
@@ -395,19 +395,19 @@ them. For this reason the following functions are provided.
@itemize
-@item @ref{gnutls_crypto_cipher_register2}
+@item @refint{gnutls_crypto_cipher_register}
To override the cryptographic algorithms backend.
-@item @ref{gnutls_crypto_digest_register2}
+@item @refint{gnutls_crypto_digest_register}
To override the digest algorithms backend.
-@item @ref{gnutls_crypto_rnd_register2}
+@item @refint{gnutls_crypto_rnd_register}
To override the random number generator backend.
-@item @ref{gnutls_crypto_bigint_register2}
+@item @refint{gnutls_crypto_bigint_register}
To override the big number number operations backend.
-@item @ref{gnutls_crypto_pk_register2}
+@item @refint{gnutls_crypto_pk_register}
To override the public key encryption backend. This is tight to the
big number operations so either both of them should be updated or care
must be taken to use the same format.
diff --git a/doc/gnutls.texi b/doc/gnutls.texi
index 14549b4803..144171b716 100644
--- a/doc/gnutls.texi
+++ b/doc/gnutls.texi
@@ -57,6 +57,11 @@ Documentation License''.
@insertcopying
@end titlepage
+@c reference to an internal function.
+@macro refint {func}
+@code{\func\}
+@end macro
+
@macro xcite{ref}
[\ref\] (@pxref{Bibliography})
@end macro