diff options
author | Ludovic Courtès <ludo@gnu.org> | 2011-11-03 23:50:34 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2011-11-03 23:58:21 +0100 |
commit | 30ac29b1ab63363367fca586373373d95f8eb15e (patch) | |
tree | dc4641f112e8696fad16039528f815ba7c563c2a | |
parent | 996accb26da18b07e115ed62da1683768abcc3c8 (diff) | |
download | gnutls-30ac29b1ab63363367fca586373373d95f8eb15e.tar.gz |
guile: Update doc to reflect the removal of (gnutls extra).
-rw-r--r-- | doc/Makefile.am | 14 | ||||
-rw-r--r-- | doc/gnutls-guile.texi | 45 |
2 files changed, 10 insertions, 49 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 65027a1580..2619eb87fb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -170,7 +170,7 @@ enums.texi: $(srcdir)/../lib/includes/gnutls/*.h # Guile texinfos. -guile_texi = core.c.texi extra.c.texi +guile_texi = core.c.texi BUILT_SOURCES = $(guile_texi) MAINTAINERCLEANFILES += $(guile_texi) EXTRA_DIST += $(guile_texi) extract-guile-c-doc.scm @@ -195,23 +195,11 @@ core.c.texi: $(top_srcdir)/guile/src/core.c -- "$^" "$(CPP)" "$(SNARF_CPPFLAGS) $(CPPFLAGS)" \ > "$@" -extra.c.texi: $(top_srcdir)/guile/src/extra.c - $(MAKE) -C ../guile/src built-sources && \ - $(GUILE_FOR_BUILD) -l "$(srcdir)/extract-guile-c-doc.scm" \ - -e '(apply main (cdr (command-line)))' \ - -- "$^" "$(CPP)" "$(SNARF_CPPFLAGS) $(CPPFLAGS)" \ - > "$@" - - else !HAVE_GUILE core.c.texi: echo "(Guile not available, documentation not generated.)" > $@ -extra.c.texi: - echo "(Guile not available, documentation not generated.)" > $@ - - endif !HAVE_GUILE clean-am: diff --git a/doc/gnutls-guile.texi b/doc/gnutls-guile.texi index 915aa973cd..5658b0646b 100644 --- a/doc/gnutls-guile.texi +++ b/doc/gnutls-guile.texi @@ -196,7 +196,7 @@ of the wrong type on the Scheme side: such errors are automatically detected by type-checking. The enumerate values are bound to variables exported by the -@code{(gnutls)} and @code{(gnutls extra)} modules. These variables +@code{(gnutls)} module. These variables are named according to the following convention: @itemize @@ -532,8 +532,7 @@ This is it! @node OpenPGP Authentication Guile Example @section OpenPGP Authentication Guile Example -GnuTLS allows users to authenticate using OpenPGP certificates. The -relevant procedures are provided by the @code{(gnutls extra)} module. +GnuTLS allows users to authenticate using OpenPGP certificates. Using OpenPGP-based authentication is not more complicated than using anonymous authentication. It requires a bit of extra work, though, to import the OpenPGP public and private key of the client/server. Key @@ -603,7 +602,8 @@ Similarly, server-side code would be along these lines: In practice, generating RSA parameters (and Diffie-Hellman parameters) can time a long time. Thus, you may want to generate them once and -store them in a file for future re-use (@pxref{Core Interface, @code{pkcs1-export-rsa-parameters} and @code{pkcs1-import-rsa-parameters}}). +store them in a file for future re-use (@pxref{Guile Reference, +@code{pkcs1-export-rsa-parameters} and @code{pkcs1-import-rsa-parameters}}). @node Importing OpenPGP Keys Guile Example @section Importing OpenPGP Keys Guile Example @@ -611,14 +611,14 @@ store them in a file for future re-use (@pxref{Core Interface, @code{pkcs1-expor The following example provides a simple way of importing ``ASCII-armored'' OpenPGP keys from files, using the @code{import-openpgp-certificate} and @code{import-openpgp-private-key} -procedures provided by the @code{(gnutls extra)} module. +procedures. @vindex openpgp-certificate-format/base64 @vindex openpgp-certificate-format/raw @example (use-modules (srfi srfi-4) - (gnutls extra)) + (gnutls)) (define (import-key-from-file import-proc file) ;; Import OpenPGP key from FILE using IMPORT-PROC. @@ -645,46 +645,19 @@ procedures provided by the @code{(gnutls extra)} module. The procedures @code{import-public-key-from-file} and @code{import-private-key-from-file} can be passed a file name. They return an OpenPGP public key and private key object, respectively -(@pxref{Extra Interface, OpenPGP key objects}). +(@pxref{Guile Reference, OpenPGP key objects}). @c ********************************************************************* @node Guile Reference @chapter Guile Reference -This chapter documents GnuTLS Scheme procedures available to Guile -programmers. - -@menu -* Core Interface:: Bindings for core GnuTLS. -* Extra Interface:: Bindings for GnuTLS-Extra. -@end menu - -@node Core Interface -@section Core Interface - -This section lists the Scheme procedures exported by the +This chapter lists the GnuTLS Scheme procedures exported by the @code{(gnutls)} module (@pxref{The Guile module system,,, guile, The -GNU Guile Reference Manual}). This module is licenced under the GNU -Lesser General Public Licence, version 2.1 or later. +GNU Guile Reference Manual}). @include core.c.texi -@node Extra Interface -@section Extra Interface - -This section lists the Scheme procedures exported by the @code{(gnutls -extra)} module. This module is licenced under the GNU General Public -Licence, version 3 or later. - -@include extra.c.texi - - - -@ignore -;;; arch-tag: ee5f2081-9153-48fc-b4ee-2024381c65d7 -@end ignore - @c Local Variables: @c ispell-local-dictionary: "american" @c End: |