Re: suggestion: move "Gnulib module: --" blurb to misc notes

[Thien-Thi Nguyen]

() Bruno Haible <address@hidden>
() Thu, 6 Mar 2008 15:04:12 +0100

   Hmm, I would prefer to copy this paragraph to the beginning of
   each of the 4 header file / function substitutes chapters.
   Without this paragraph, people did not understand what the
   notation means.

Sounds reasonable.  Below is a patch.  Here is a ChangeLog entry:

 Distribute "Gnulib module: --" blurb to four reference chapters.
 * doc/gnulib.texi (nosuchmodulenote): New macro.
 (Header File Substitutes, Functions Substitutes)
 (Glibc Header File Substitutes, Glibc Function Substitutes):
 Use address@hidden'.

thi

_____________________________________________________

-*- mode: compilation; default-directory: "~/build/GNU/gnulib/doc/" -*-
Compilation started at Thu Mar  6 15:44:58

git diff ttn-was docfixes -- gnulib.texi
diff --git a/doc/gnulib.texi b/doc/gnulib.texi
index 270bcb7..3fe79c7 100644
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -386,7 +386,7 @@ On a machine with recent automake, autoconf, m4 installed 
and with a
 gnulib git or cvs checkout (typically a Linux machine), use
 
 @example
-gnulib-tool --create-megatestdir --with-tests --dir=..."
+gnulib-tool --create-megatestdir --with-tests --dir=...
 @end example
 
 Note: The created directory uses ca. 512 MB on disk.
@@ -454,6 +454,19 @@ source code, or when the program uses a mix between C and 
C++ sources
 (requiring separate builds of the @code{posixlib} for the C compiler and
 for the C++ compiler).
 
address@hidden This is used at the beginning of the following four chapters.
address@hidden nosuchmodulenote{thing}
+The notation ``Gnulib module: ---'' means that Gnulib does not provide a
+module providing a substitute for the \thing\.  When the list
+``Portability problems not fixed by Gnulib'' is empty, such a module is
+not needed: No portability problems are known.
+
+Otherwise, it indicates that such a module would be useful but is not
+available: No one so far found this \thing\ important enough to
+contribute a substitute for it.  If you need this particular \thing\,
+you may write to @code{<bug-gnulib at gnu dot org>}.
address@hidden macro
+
 @node Header File Substitutes
 @chapter ISO C and POSIX Header File Substitutes
 
@@ -461,6 +474,8 @@ This chapter describes which header files specified by ISO 
C or POSIX are
 substituted by Gnulib, which portability pitfalls are fixed by Gnulib, and
 which (known) portability problems are not worked around by Gnulib.
 
address@hidden header
+
 @menu
 * aio.h::
 * arpa/inet.h::
@@ -641,14 +656,7 @@ ISO C or POSIX are substituted by Gnulib, which 
portability pitfalls are
 fixed by Gnulib, and which (known) portability problems are not worked around
 by Gnulib.
 
-The notation ``Gnulib module: ---'' means that Gnulib does not provide a
-module providing a substitute for the function.  When the list
-``Portability problems not fixed by Gnulib'' is empty, such a module is
-not needed: No portability problems are known.  Otherwise, it indicates
-that such a module would be useful but is not available: No one so far
-found this function important enough to contribute a substitute for it.
-If you need this particular function, you may write to
address@hidden<bug-gnulib at gnu dot org>}.
address@hidden function
 
 @menu
 * FD_CLR::
@@ -2898,6 +2906,8 @@ specified by ISO C or POSIX are substituted by Gnulib, 
which portability
 pitfalls are fixed by Gnulib, and which (known) portability problems are
 not worked around by Gnulib.
 
address@hidden header
+
 @menu
 * a.out.h::
 * aliases.h::
@@ -2970,14 +2980,7 @@ provided as extensions by at least GNU libc are also 
supported by Gnulib,
 which portability pitfalls are fixed by Gnulib, and which (known)
 portability problems are not worked around by Gnulib.
 
-The notation ``Gnulib module: ---'' means that Gnulib does not provide a
-module providing a substitute for the function.  When the list
-``Portability problems not fixed by Gnulib'' is empty, such a module is
-not needed: No portability problems are known.  Otherwise, it indicates
-that such a module would be useful but is not available: No one so far
-found this function important enough to contribute a substitute for it.
-If you need this particular function, you may write to
address@hidden<bug-gnulib at gnu dot org>}.
address@hidden function
 
 This list of functions is sorted according to the header that declares them.
 

Compilation finished at Thu Mar  6 15:44:58