Re: [gnutls-dev] Preparing for the next stable release

[Ludovic Courtès]

Hi,

Simon Josefsson <address@hidden> writes:

> I'd say a good compromise here seems to be to change the titles but not
> the node names.

Ok, see attached patch.

For some reason, I'm now (again) unable to produce the PDF.  The
relevant error message is:

  ! Emergency stop.
  <*> ...ut /home/ludo/src/gnutls/doc/internals.texi

  *** (job aborted, no legal \end found)

  !  ==> Fatal error occurred, no output PDF file produced!

Any idea?

Thanks,
Ludovic.

>From 885014cfa24f8c6e01d0f35b94835ae700fc619c Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Ludovic=20Court=C3=A8s?= <address@hidden>
Date: Sun, 8 Jul 2007 16:41:42 +0200
Subject: [PATCH] Manual: Capitalized section and chapter titles.

* doc/gnutls.texi: Capitalized section and chapter titles.
  (Certificate to XML convertion functions): Fixed typo both in node
  name and chapter title.  Updated menu.

* doc/internals.texi: Likewise.
---
 doc/gnutls.texi    |   84 ++++++++++++++++++++++++++--------------------------
 doc/internals.texi |   10 +++---
 2 files changed, 47 insertions(+), 47 deletions(-)

diff --git a/doc/gnutls.texi b/doc/gnutls.texi
index cb2c0c7..bdc302e 100644
--- a/doc/gnutls.texi
+++ b/doc/gnutls.texi
@@ -81,7 +81,7 @@ Documentation License''.
 * How to use GnuTLS in applications::
 * Included programs::
 * Function reference::
-* Certificate to XML convertion functions::
+* Certificate to XML Conversion Functions::
 * All the supported ciphersuites in GnuTLS::
 * Guile Bindings::
 * Internal architecture of GnuTLS::
@@ -131,7 +131,7 @@ will be available from @url{http://www.gnutls.org/} and
 @end menu
 
 @node Getting help
address@hidden Getting help
address@hidden Getting Help
 
 A mailing list where users may help each other exists, and you can
 reach it by sending e-mail to @email{help-gnutls@@gnu.org}.  Archives
@@ -472,7 +472,7 @@ the stored session will be retrieved, and the new session 
will be a
 resumed one, and will share the same session ID with the previous one.
 
 @node Error handling
address@hidden Error handling
address@hidden Error Handling
 
 In @acronym{GnuTLS} most functions return an integer type as a result.  In
 almost all cases a zero or a positive number means success, and a
@@ -495,7 +495,7 @@ a function, these error codes will be documented in the 
function's
 reference.  @xref{Error Codes}, for all the error codes.
 
 @node Memory handling
address@hidden Memory handling
address@hidden Memory Handling
 
 @acronym{GnuTLS} internally handles heap allocated objects
 differently, depending on the sensitivity of the data they
@@ -513,7 +513,7 @@ secure. See the documentation of @acronym{Libgcrypt} for 
more
 information.
 
 @node Callback functions
address@hidden Callback functions
address@hidden Callback Functions
 @cindex Callback functions
 
 There are several cases where @acronym{GnuTLS} may need some out of
@@ -574,7 +574,7 @@ differences of these protocols are minor. Older protocols 
such as
 @end menu
 
 @node TLS layers
address@hidden TLS layers
address@hidden TLS Layers
 @cindex TLS Layers
 
 @acronym{TLS} is a layered protocol, and consists of the Record
@@ -596,7 +596,7 @@ protocol.  The protocol layering in TLS is shown in the 
figure below.
 @image{layers,12cm,8cm}
 
 @node The transport layer
address@hidden The transport layer
address@hidden The Transport Layer
 @cindex Transport protocol
 
 @acronym{TLS} is not limited to one transport layer, it can be used
@@ -642,7 +642,7 @@ work, thus making it easy to add @acronym{TLS} support to 
existing
 TCP/IP servers.
 
 @node The TLS record protocol
address@hidden The TLS record protocol
address@hidden The TLS Record Protocol
 @cindex Record protocol
 
 The Record protocol is the secure communications provider. Its purpose
@@ -1024,7 +1024,7 @@ used to enable this extension, or to retrieve the name 
sent by a
 client.
 
 @node On SSL 2 and older protocols
address@hidden On SSL 2 and older protocols
address@hidden On SSL 2 and Older Protocols
 @cindex SSL 2
 
 One of the initial decisions in the @acronym{GnuTLS} development was
@@ -1071,7 +1071,7 @@ Other protocols such as Microsoft's @acronym{PCT} 1 and 
@acronym{PCT}
 by @acronym{SSL} 3.0 and later @acronym{TLS} 1.0.
 
 @node Authentication methods
address@hidden Authentication methods
address@hidden Authentication Methods
 
 The @acronym{TLS} protocol provides confidentiality and encryption,
 but also offers authentication, which is a prerequisite for a secure
@@ -1100,7 +1100,7 @@ are:
 @end menu
 
 @node Certificate authentication
address@hidden Certificate authentication
address@hidden Certificate Authentication
 
 @subsection Authentication using @acronym{X.509} certificates
 @cindex @acronym{X.509} certificates
@@ -1249,7 +1249,7 @@ Signature Standard.
 @end table
 
 @node Anonymous authentication
address@hidden Anonymous authentication
address@hidden Anonymous Authentication
 @cindex Anonymous authentication
 
 The anonymous key exchange performs encryption but there is no
@@ -1413,7 +1413,7 @@ maintain @acronym{PSK} keys.
 
 
 @node Authentication and credentials
address@hidden Authentication and credentials
address@hidden Authentication and Credentials
 
 In @acronym{GnuTLS} every key exchange method is associated with a
 credentials type. So in order to enable to enable a specific method,
@@ -1455,7 +1455,7 @@ Key exchange algorithms and the corresponding credential 
types:
 @end multitable
 
 @node Parameters stored in credentials
address@hidden Parameters stored in credentials
address@hidden Parameters Stored in Credentials
 
 Several parameters such as the ones used for Diffie-Hellman
 authentication are stored within the credentials structures, so all
@@ -1514,7 +1514,7 @@ int main()
 @end example
 
 @node More on certificate authentication
address@hidden More on certificate authentication
address@hidden More on Certificate Authentication
 @anchor{Certificate Authentication}
 @cindex Certificate authentication
 
@@ -1525,7 +1525,7 @@ int main()
 @end menu
 
 @node The X.509 trust model
address@hidden The @acronym{X.509} trust model
address@hidden The @acronym{X.509} Trust Model
 @cindex @acronym{X.509} certificates
 
 The @acronym{X.509} protocols rely on a hierarchical trust model. In
@@ -1757,7 +1757,7 @@ An example of a @acronym{PKCS} #12 structure generation 
can be found
 at section @ref{ex:pkcs12}.
 
 @node The OpenPGP trust model
address@hidden The @acronym{OpenPGP} trust model
address@hidden The @acronym{OpenPGP} Trust Model
 @cindex @acronym{OpenPGP} Keys
 
 The @acronym{OpenPGP} key authentication relies on a distributed trust
@@ -1835,13 +1835,13 @@ These algorithms have been broken and should not be 
trusted.
 @end table
 
 @node Digital signatures
address@hidden Digital signatures
address@hidden Digital Signatures
 @cindex Digital signatures
 @include signatures.texi
 
 
 @node How to use TLS in application protocols
address@hidden How to use @acronym{TLS} in application protocols
address@hidden How To Use @acronym{TLS} in Application Protocols
 
 This chapter is intended to provide some hints on how to use the
 @acronym{TLS} over simple custom made application protocols.  The
@@ -1854,7 +1854,7 @@ but may be extended to other ones too.
 @end menu
 
 @node Separate ports
address@hidden Separate ports
address@hidden Separate Ports
 
 Traditionally @acronym{SSL} was used in application protocols by
 assigning a new port number for the secure services. That way two
@@ -1881,7 +1881,7 @@ is a limitation on the available privileged ports, this 
approach was
 soon obsoleted.
 
 @node Upward negotiation
address@hidden Upward negotiation
address@hidden Upward Negotiation
 
 Other application address@hidden LDAP, IMAP etc.}  use a
 different approach to enable the secure layer.  They use something
@@ -1972,7 +1972,7 @@ password address@hidden @acronym{SRP} authentication}, or 
anything
 else!
 
 @node How to use GnuTLS in applications
address@hidden How to use @acronym{GnuTLS} in applications
address@hidden How To Use @acronym{GnuTLS} in Applications
 @anchor{examples}
 @cindex Example programs
 
@@ -2131,7 +2131,7 @@ int main()
 @end itemize
 
 @node Client examples
address@hidden Client examples
address@hidden Client Examples
 
 This section contains examples of @acronym{TLS} and @acronym{SSL}
 clients, using @acronym{GnuTLS}.  Note that these examples contain
@@ -2261,7 +2261,7 @@ other examples.  It is required to build some examples.
 @verbatiminclude examples/tcp.c
 
 @node Server examples
address@hidden Server examples
address@hidden Server Examples
 
 This section contains examples of @acronym{TLS} and @acronym{SSL}
 servers, using @acronym{GnuTLS}.
@@ -2330,7 +2330,7 @@ serve the example client with authorization support.
 @verbatiminclude examples/ex-serv-authz.c
 
 @node Miscellaneous examples
address@hidden Miscellaneous examples
address@hidden Miscellaneous Examples
 
 @menu
 * Checking for an alert::
@@ -2377,7 +2377,7 @@ structure.
 @verbatiminclude examples/ex-pkcs12.c
 
 @node Compatibility with the OpenSSL library
address@hidden Compatibility with the OpenSSL library
address@hidden Compatibility with the OpenSSL Library
 @cindex OpenSSL
 
 To ease @acronym{GnuTLS}' integration with existing applications, a
@@ -2400,7 +2400,7 @@ Current limitations imposed by the compatibility layer 
include:
 @end itemize
 
 @node Included programs
address@hidden Included programs
address@hidden Included Programs
 
 Included with @acronym{GnuTLS} are also a few command line tools that
 let you use the library for common tasks without writing an
@@ -3067,7 +3067,7 @@ signing_key
 @end example
 
 @node Function reference
address@hidden Function reference
address@hidden Function Reference
 @cindex Function reference
 
 @menu
@@ -3080,7 +3080,7 @@ signing_key
 @end menu
 
 @node Core functions
address@hidden Core functions
address@hidden Core Functions
 
 The prototypes for the following functions lie in
 @file{gnutls/gnutls.h}.
@@ -3088,7 +3088,7 @@ The prototypes for the following functions lie in
 @include gnutls-api.texi
 
 @node X.509 certificate functions
address@hidden @acronym{X.509} certificate functions
address@hidden @acronym{X.509} Certificate Functions
 @anchor{sec:x509api}
 @cindex @acronym{X.509} Functions
 
@@ -3098,7 +3098,7 @@ Their prototypes lie in @file{gnutls/x509.h}.
 @include x509-api.texi
 
 @node GnuTLS-extra functions
address@hidden @acronym{GnuTLS-extra} functions
address@hidden @acronym{GnuTLS-extra} Functions
 @cindex @acronym{GnuTLS-extra} functions
 
 These functions are only available in the GPL version of the library
@@ -3108,7 +3108,7 @@ called @code{gnutls-extra}. The prototypes for this 
library lie in
 @include gnutls-extra-api.texi
 
 @node OpenPGP functions
address@hidden @acronym{OpenPGP} functions
address@hidden @acronym{OpenPGP} Functions
 @cindex @acronym{OpenPGP} functions
 @anchor{sec:openpgpapi}
 
@@ -3120,7 +3120,7 @@ to be able to use these functions (@pxref{GnuTLS-extra 
functions}).
 @include pgp-api.texi
 
 @node TLS Inner Application (TLS/IA) functions
address@hidden @acronym{TLS} Inner Application (@acronym{TLS/IA}) functions
address@hidden @acronym{TLS} Inner Application (@acronym{TLS/IA}) Functions
 @cindex @acronym{TLS} Inner Application (@acronym{TLS/IA}) functions
 @cindex Inner Application (@acronym{TLS/IA}) functions
 
@@ -3177,7 +3177,7 @@ client functions with the corresponding server functions.
 @include ia-api.texi
 
 @node Error codes and descriptions
address@hidden Error codes and descriptions
address@hidden Error Codes and Descriptions
 @anchor{Error Codes}
 @cindex Error codes
 
@@ -3188,11 +3188,11 @@ expressions.
 
 @include error_codes.texi
 
address@hidden Certificate to XML convertion functions
address@hidden Certificate to @acronym{XML} convertion functions
address@hidden Certificate to XML convertion
address@hidden Certificate to XML Conversion Functions
address@hidden Certificate to @acronym{XML} Conversion Functions
address@hidden Certificate to XML conversion
 
-This appendix contains some example output of the XML convertion
+This appendix contains some example output of the XML conversion
 functions:
 
 @itemize
@@ -3209,7 +3209,7 @@ functions:
 @end menu
 
 @node An X.509 certificate
address@hidden An @acronym{X.509} certificate
address@hidden An @acronym{X.509} Certificate
 
 @smallexample
 <?xml version="1.0" encoding="UTF-8"?>
@@ -3412,7 +3412,7 @@ functions:
 @end smallexample
 
 @node An OpenPGP key
address@hidden An @acronym{OpenPGP} key
address@hidden An @acronym{OpenPGP} Key
 
 @smallexample
 <?xml version="1.0"?>
@@ -3493,7 +3493,7 @@ functions:
 @end smallexample
 
 @node All the supported ciphersuites in GnuTLS
address@hidden All the supported ciphersuites in @acronym{GnuTLS}
address@hidden All the Supported Ciphersuites in @acronym{GnuTLS}
 @anchor{ciphersuites}
 @cindex Ciphersuites
 
@@ -3632,7 +3632,7 @@ functions:
 @include guile.texi
 
 @node Internal architecture of GnuTLS
address@hidden Internal architecture of GnuTLS
address@hidden Internal Architecture of GnuTLS
 @cindex Internal architecture
 @include internals.texi
 
diff --git a/doc/internals.texi b/doc/internals.texi
index 35752d8..9437278 100644
--- a/doc/internals.texi
+++ b/doc/internals.texi
@@ -3,7 +3,7 @@ way @acronym{GnuTLS} works. The focus is to give an idea
 to potential developers and those who want to know what
 happens inside the black box.
 
address@hidden The TLS protocol
address@hidden The TLS Protocol
 The main needs for the TLS protocol to be used are
 shown in the image below.
 
@@ -15,7 +15,7 @@ object are just structures with attributes. The operations 
listed
 are functions that require the first parameter to be that object.
 @image{arch/objects,15cm}
 
address@hidden TLS Handshake protocol
address@hidden TLS Handshake Protocol
 The @acronym{GnuTLS} handshake protocol is implemented as a state
 machine that waits for input or returns immediately when the non-blocking
 transport layer functions are used. The main idea is shown in the following
@@ -32,7 +32,7 @@ certificate ciphersuite.
 
 @image{arch/handshake-sequence,12cm}
 
address@hidden TLS authentication methods
address@hidden TLS Authentication Methods
 In @acronym{GnuTLS} authentication methods can be implemented quite easily.
 Since the required changes to add a new authentication method affect only the
 handshake protocol, a simple interface is used. An authentication method needs
@@ -49,7 +49,7 @@ for PSK ciphersuites and @code{auth_srp.c} for SRP 
ciphersuites. After implement
 the structure holding its pointers has to be registered in 
@code{gnutls_algorithms.c}
 in the @code{_gnutls_kx_algorithms} structure.
 
address@hidden TLS Extension handling
address@hidden TLS Extension Handling
 As with authentication methods, the TLS extensions handlers can be implemented
 using the following interface.
 
@@ -65,7 +65,7 @@ handle, they have to be registered in 
@code{gnutls_extensions.c} in the
 @code{_gnutls_extensions} structure.
 
 
address@hidden Certificate handling
address@hidden Certificate Handling
 What is provided by the certificate handling functions
 is summarized in the following diagram.
 
-- 
1.5.2.1