changeset 9766:bef0d9fb5b1b

Consistent explanation of "Gnulib module: ..." notation.
author Thien-Thi Nguyen <ttn@gnuvola.org>
date Thu, 06 Mar 2008 18:43:12 +0100
parents b83130da6c6a
children 05802ff94555
files ChangeLog doc/gnulib.texi
diffstat 2 files changed, 26 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-03-06  Thien-Thi Nguyen  <ttn@gnuvola.org>  (tiny change)
+
+	* doc/gnulib-tool.texi (@nosuchmodulenote): New macro.
+	(Header File Substitutes, Function Substitutes,
+	Glibc Header File Substitutes, Glibc Function Substitutes): Use it.
+	(Build robot for gnulib): Fix typo.
+
 2008-03-06  Bruno Haible  <bruno@clisp.org>
 
 	* doc/gnulib-tool.texi (VCS Issues): Small updates.
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -65,6 +65,18 @@
 * Index::
 @end menu
 
+@c This is used at the beginning of four chapters.
+@macro 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>}.
+@end macro
+
 @node Introduction
 @chapter Introduction
 
@@ -386,7 +398,7 @@
 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.
@@ -461,6 +473,8 @@
 substituted by Gnulib, which portability pitfalls are fixed by Gnulib, and
 which (known) portability problems are not worked around by Gnulib.
 
+@nosuchmodulenote header file
+
 @menu
 * aio.h::
 * arpa/inet.h::
@@ -641,14 +655,7 @@
 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
-@code{<bug-gnulib at gnu dot org>}.
+@nosuchmodulenote function
 
 @menu
 * FD_CLR::
@@ -2898,6 +2905,8 @@
 pitfalls are fixed by Gnulib, and which (known) portability problems are
 not worked around by Gnulib.
 
+@nosuchmodulenote header
+
 @menu
 * a.out.h::
 * aliases.h::
@@ -2970,14 +2979,7 @@
 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
-@code{<bug-gnulib at gnu dot org>}.
+@nosuchmodulenote function
 
 This list of functions is sorted according to the header that declares them.