summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Josefsson <simon@josefsson.org>2010-04-25 17:04:11 +0200
committerSimon Josefsson <simon@josefsson.org>2010-04-25 17:04:11 +0200
commit9cb0352b9af790c7a988fc3fab0fd98c39161267 (patch)
treeaf7bb29366d6c080546a95e91c033365e47ac93f
parentbaa4d0c190055febc68b12e2bd34bf2fc9f10e9e (diff)
downloadgnutls-9cb0352b9af790c7a988fc3fab0fd98c39161267.tar.gz
Mention shared library map file and GTK-DOC guidelines.
-rw-r--r--doc/gnutls.texi9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/gnutls.texi b/doc/gnutls.texi
index e761c68e7c..f0e1f883d4 100644
--- a/doc/gnutls.texi
+++ b/doc/gnutls.texi
@@ -4021,6 +4021,15 @@ You can implement the API function in the @code{ext_foobar.c} file, or
if that file ends up becoming rather larger, add a
@code{gnutls_foobar.c} file.
+To make the API available in the shared library you need to add the
+symbol in @code{lib/libgnutls.map} or
+@code{libextra/libgnutls-extra.map} as appropriate, so that the symbol
+is exported properly.
+
+When writing GTK-DOC style documentation for your new APIs, don't
+forget to add @code{Since:} tags to indicate the GnuTLS version the
+API was introduced in.
+
@end enumerate
@section Certificate Handling