From c54e5cf7db32709b4f04a117f44f69dc5684cbf2 Mon Sep 17 00:00:00 2001 From: Carlos O'Donell Date: Thu, 17 Apr 2014 19:41:09 -0400 Subject: [PATCH] manual: Sort overview listing by manual order. In the glibc manual we have a "Roadmap to the manual" section at the end of the "Introduction" chapter. The introductory text says "Here is an overview of the contents of the remaining chapters of this manual.", but then proceeds to list chapters out of order and some chapter are never referenced. This commit reorders the overview to correctly match the manual order. See: https://sourceware.org/ml/libc-alpha/2014-02/msg00823.html --- ChangeLog | 5 +++ manual/intro.texi | 105 +++++++++++++++++++++++++++++++++------------- 2 files changed, 82 insertions(+), 28 deletions(-) diff --git a/ChangeLog b/ChangeLog index 23cded5e1c..e09fdc6263 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2014-04-17 Carlos O'Donell + + * manual/intro.texi (Roadmap to the manual): Sort chapter listing to + match manual order. + 2014-04-17 Adhemerval Zanella * nptl/sysdeps/unix/sysv/linux/powerpc/pthread_once.c: Remove file. diff --git a/manual/intro.texi b/manual/intro.texi index 0f5785990b..d4045f2e06 100644 --- a/manual/intro.texi +++ b/manual/intro.texi @@ -1283,19 +1283,59 @@ The header file @file{termios.h} reserves names prefixed with @samp{c_}, Here is an overview of the contents of the remaining chapters of this manual. +@c The chapter overview ordering is: +@c Error Reporting (2) +@c Virtual Memory Allocation and Paging (3) +@c Character Handling (4) +@c Strings and Array Utilities (5) +@c Character Set Handling (6) +@c Locales and Internationalization (7) +@c Searching and Sorting (9) +@c Pattern Matching (10) +@c Input/Output Overview (11) +@c Input/Output on Streams (12) +@c Low-level Input/Ooutput (13) +@c File System Interface (14) +@c Pipes and FIFOs (15) +@c Sockets (16) +@c Low-Level Terminal Interface (17) +@c Syslog (18) +@c Mathematics (19) +@c Aritmetic Functions (20) +@c Date and Time (21) +@c Non-Local Exist (23) +@c Signal Handling (24) +@c The Basic Program/System Interface (25) +@c Processes (26) +@c Job Control (28) +@c System Databases and Name Service Switch (29) +@c Users and Groups (30) -- References `User Database' and `Group Database' +@c System Management (31) +@c System Configuration Parameters (32) +@c C Language Facilities in the Library (AA) +@c Summary of Library Facilities (AB) +@c Installing (AC) +@c Library Maintenance (AD) + +@c The following chapters need overview text to be added: +@c Message Translation (8) +@c Resource Usage And Limitations (22) +@c Inter-Process Communication (27) +@c DES Encryption and Password Handling (33) +@c Debugging support (34) +@c POSIX Threads (35) +@c Internal Probes (36) +@c Platform-specific facilities (AE) +@c Contributors to (AF) +@c Free Software Needs Free Documentation (AG) +@c GNU Lesser General Public License (AH) +@c GNU Free Documentation License (AI) + @itemize @bullet @item @ref{Error Reporting}, describes how errors detected by the library are reported. -@item -@ref{Language Features}, contains information about library support for -standard parts of the C language, including things like the @code{sizeof} -operator and the symbolic constant @code{NULL}, how to write functions -accepting variable numbers of arguments, and constants describing the -ranges and other properties of the numerical types. There is also a simple -debugging mechanism which allows you to put assertions in your code, and -have diagnostic messages printed if the tests fail. @item @ref{Memory}, describes @theglibc{}'s facilities for managing and @@ -1314,6 +1354,26 @@ performing case conversion. manipulating strings (null-terminated character arrays) and general byte arrays, including operations such as copying and comparison. +@item +@ref{Character Set Handling}, contains information about manipulating +characters and strings using character sets larger than will fit in +the usual @code{char} data type. + +@item +@ref{Locales}, describes how selecting a particular country +or language affects the behavior of the library. For example, the locale +affects collation sequences for strings and how monetary values are +formatted. + +@item +@ref{Searching and Sorting}, contains information about functions +for searching and sorting arrays. You can use these functions on any +kind of array by providing an appropriate comparison function. + +@item +@ref{Pattern Matching}, presents functions for matching regular expressions +and shell file name patterns, and for expanding words as the shell does. + @item @ref{I/O Overview}, gives an overall look at the input and output facilities in the library, and contains information about basic concepts @@ -1365,30 +1425,10 @@ exponential functions on floating-point numbers. for simple arithmetic, analysis of floating-point values, and reading numbers from strings. -@item -@ref{Searching and Sorting}, contains information about functions -for searching and sorting arrays. You can use these functions on any -kind of array by providing an appropriate comparison function. - -@item -@ref{Pattern Matching}, presents functions for matching regular expressions -and shell file name patterns, and for expanding words as the shell does. - @item @ref{Date and Time}, describes functions for measuring both calendar time and CPU time, as well as functions for setting alarms and timers. -@item -@ref{Character Set Handling}, contains information about manipulating -characters and strings using character sets larger than will fit in -the usual @code{char} data type. - -@item -@ref{Locales}, describes how selecting a particular country -or language affects the behavior of the library. For example, the locale -affects collation sequences for strings and how monetary values are -formatted. - @item @ref{Non-Local Exits}, contains descriptions of the @code{setjmp} and @code{longjmp} functions. These functions provide a facility for @@ -1434,6 +1474,15 @@ is executing under. various operating system limits. Most of these parameters are provided for compatibility with POSIX. +@item +@ref{Language Features}, contains information about library support for +standard parts of the C language, including things like the @code{sizeof} +operator and the symbolic constant @code{NULL}, how to write functions +accepting variable numbers of arguments, and constants describing the +ranges and other properties of the numerical types. There is also a simple +debugging mechanism which allows you to put assertions in your code, and +have diagnostic messages printed if the tests fail. + @item @ref{Library Summary}, gives a summary of all the functions, variables, and macros in the library, with complete data types and function prototypes,