diff options
author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2011-12-29 21:10:44 +0200 |
---|---|---|
committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2011-12-29 21:13:54 +0200 |
commit | 6e1f1f28325a352a8946a74a0ad16e3f17f26335 (patch) | |
tree | e7bda420ca269b4790eb12027a579329235eb877 | |
parent | 941b82caa389cca3b1dc9a951550f0dadf697aac (diff) | |
download | gnutls-6e1f1f28325a352a8946a74a0ad16e3f17f26335.tar.gz |
Small improvements in documentation.
-rw-r--r-- | doc/cha-ciphersuites.texi | 4 | ||||
-rw-r--r-- | doc/cha-copying.texi | 10 | ||||
-rw-r--r-- | doc/cha-gtls-app.texi | 2 | ||||
-rw-r--r-- | doc/cha-gtls-examples.texi | 7 | ||||
-rw-r--r-- | doc/cha-internals.texi | 11 | ||||
-rw-r--r-- | doc/cha-library.texi | 14 | ||||
-rw-r--r-- | doc/cha-shared-key.texi | 4 | ||||
-rw-r--r-- | doc/gnutls.texi | 2 |
8 files changed, 23 insertions, 31 deletions
diff --git a/doc/cha-ciphersuites.texi b/doc/cha-ciphersuites.texi index fcf650a3ee..24288f8e9e 100644 --- a/doc/cha-ciphersuites.texi +++ b/doc/cha-ciphersuites.texi @@ -1,5 +1,5 @@ -@node Supported ciphersuites in GnuTLS -@appendix Supported Ciphersuites in @acronym{GnuTLS} +@node Supported ciphersuites +@appendix Supported Ciphersuites @anchor{ciphersuites} @cindex ciphersuites diff --git a/doc/cha-copying.texi b/doc/cha-copying.texi index 183006a6b7..7d29cc4e89 100644 --- a/doc/cha-copying.texi +++ b/doc/cha-copying.texi @@ -1,14 +1,8 @@ @node Copying Information @appendix Copying Information - -@menu -* GNU Free Documentation License:: License for copying this manual. -@end menu - -@node GNU Free Documentation License -@appendixsec GNU Free Documentation License - @cindex FDL, GNU Free Documentation License +@heading GNU Free Documentation License + @include fdl-1.3.texi diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi index 3bd9866a59..3a9d4f7a0d 100644 --- a/doc/cha-gtls-app.texi +++ b/doc/cha-gtls-app.texi @@ -125,7 +125,7 @@ threads as long as a single thread accesses a single object. This is sufficient to support a server which handles several sessions per thread. If, however, an object needs to be shared across threads then access must be protected with a mutex. Read-only access to objects, for example the -credentials holding structures (see @ref{Authentication}), is also thread-safe. +credentials holding structures, is also thread-safe. The random generator of the cryptographic back-end, is not thread safe and requires mutex locks which are setup by @acronym{GnuTLS}. diff --git a/doc/cha-gtls-examples.texi b/doc/cha-gtls-examples.texi index fed30d5ab7..d62de93fb6 100644 --- a/doc/cha-gtls-examples.texi +++ b/doc/cha-gtls-examples.texi @@ -4,6 +4,10 @@ @cindex example programs @cindex examples +In this chapter several examples of real-world use cases are listed. +The examples are simplified to promote readability and contain little or +no error checking. + @menu * Client examples:: * Server examples:: @@ -14,8 +18,7 @@ @section Client examples This section contains examples of @acronym{TLS} and @acronym{SSL} -clients, using @acronym{GnuTLS}. Note that these examples contain -little or no error checking. Some of the examples require functions +clients, using @acronym{GnuTLS}. Note that some of the examples require functions implemented by another example. @menu diff --git a/doc/cha-internals.texi b/doc/cha-internals.texi index d7ec1670ab..649144e9d2 100644 --- a/doc/cha-internals.texi +++ b/doc/cha-internals.texi @@ -117,12 +117,7 @@ together with the extension number they handle, they have to be registered using @funcintref{_gnutls_ext_register} in @code{gnutls_extensions.c} typically within @funcintref{_gnutls_ext_init}. -@menu -* Adding a new TLS extension:: -@end menu - -@node Adding a new TLS extension -@subsection Adding a new TLS extension +@subheading Adding a new TLS extension Adding support for a new TLS extension is done from time to time, and the process to do so is not difficult. Here are the steps you need to @@ -346,12 +341,12 @@ The TLS layer uses a cryptographic provider layer, that will in turn either use the default crypto provider -- a software crypto library, or use an external crypto provider, if available. -@subsection Cryptographic library layer +@subheading Cryptographic library layer The Cryptographic library layer, currently supports only libnettle. Other cryptographic libraries might be supported in the future. -@subsection External cryptography provider +@subheading External cryptography provider Systems that include a cryptographic co-processor, typically come with kernel drivers to utilize the operations from software. For this reason GnuTLS provides a layer where each individual algorithm used can be replaced diff --git a/doc/cha-library.texi b/doc/cha-library.texi index 1ee6c5139f..32ac13e1aa 100644 --- a/doc/cha-library.texi +++ b/doc/cha-library.texi @@ -1,15 +1,6 @@ @node Introduction to GnuTLS @chapter Introduction to GnuTLS -@menu -* GnuTLS introduction:: -* Downloading and installing:: -* Document overview:: -@end menu - -@node GnuTLS introduction -@section Introduction - In brief @acronym{GnuTLS} can be described as a library which offers an API to access secure communication protocols. These protocols provide privacy over insecure lines, and were designed to prevent @@ -49,6 +40,11 @@ libtasn1@footnote{@url{http://www.gnu.org/software/libtasn1/}} library. The ``Cryptographic back-end'' is provided by the nettle@footnote{@url{http://www.lysator.liu.se/~nisse/nettle/}} library. +@menu +* Downloading and installing:: +* Document overview:: +@end menu + @node Downloading and installing @section Downloading and installing @cindex installation diff --git a/doc/cha-shared-key.texi b/doc/cha-shared-key.texi index eb62959474..28405aa110 100644 --- a/doc/cha-shared-key.texi +++ b/doc/cha-shared-key.texi @@ -1,6 +1,10 @@ @node Shared-key and anonymous authentication @chapter Shared-key and anonymous authentication +In addition to certificate authentication, the TLS protocol may be +used with password, shared-key and anonymous authentication methods. +The rest of this chapter discusses details of these methods. + @menu * SRP authentication:: * PSK authentication:: diff --git a/doc/gnutls.texi b/doc/gnutls.texi index 2f8164b58e..e538d09f53 100644 --- a/doc/gnutls.texi +++ b/doc/gnutls.texi @@ -158,7 +158,7 @@ Documentation License''. * Support:: * Error codes:: * API reference:: -* Supported ciphersuites in GnuTLS:: +* Supported ciphersuites:: * Copying Information:: * Concept Index:: * Function and Data Index:: |