changeset 39752:65bc0f9b42bf

doc: For module names, use texinfo markup @code{} or @samp{}. * doc/alloca.texi: Mark gnulib module names with @code. * doc/alloca-opt.texi: Likewise. * doc/quote.texi: Likewise. * doc/posix-functions/freopen.texi: Likewise. * doc/posix-functions/open.texi: Likewise. * doc/posix-functions/readlink.texi: Likewise. * doc/posix-functions/readlinkat.texi: Likewise. * doc/posix-functions/stdout.texi: Likewise. * doc/posix-functions/stderr.texi: Likewise. * doc/posix-functions/unlink.texi: Likewise. * doc/posix-functions/unlinkat.texi: Likewise. * doc/posix-functions/utime.texi: Likewise. * doc/posix-functions/utimensat.texi: Likewise. * doc/posix-functions/utimes.texi: Likewise. * doc/posix-headers/stdint.texi: Likewise. * doc/glibc-functions/futimesat.texi: Likewise. * doc/glibc-functions/lutimes.texi: Likewise. * doc/glibc-functions/memmem.texi: Likewise.
author Bruno Haible <bruno@clisp.org>
date Tue, 24 Jul 2018 03:31:36 +0200
parents 9b497a01631e
children 6eeae511ef27
files ChangeLog doc/alloca-opt.texi doc/alloca.texi doc/glibc-functions/futimesat.texi doc/glibc-functions/lutimes.texi doc/glibc-functions/memmem.texi doc/posix-functions/freopen.texi doc/posix-functions/open.texi doc/posix-functions/readlink.texi doc/posix-functions/readlinkat.texi doc/posix-functions/stderr.texi doc/posix-functions/stdout.texi doc/posix-functions/unlink.texi doc/posix-functions/unlinkat.texi doc/posix-functions/utime.texi doc/posix-functions/utimensat.texi doc/posix-functions/utimes.texi doc/posix-headers/stdint.texi doc/quote.texi
diffstat 19 files changed, 42 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Tue Jul 24 02:46:14 2018 +0200
+++ b/ChangeLog	Tue Jul 24 03:31:36 2018 +0200
@@ -1,3 +1,25 @@
+2018-07-23  Bruno Haible  <bruno@clisp.org>
+
+	doc: For module names, use texinfo markup @code{} or @samp{}.
+	* doc/alloca.texi: Mark gnulib module names with @code.
+	* doc/alloca-opt.texi: Likewise.
+	* doc/quote.texi: Likewise.
+	* doc/posix-functions/freopen.texi: Likewise.
+	* doc/posix-functions/open.texi: Likewise.
+	* doc/posix-functions/readlink.texi: Likewise.
+	* doc/posix-functions/readlinkat.texi: Likewise.
+	* doc/posix-functions/stdout.texi: Likewise.
+	* doc/posix-functions/stderr.texi: Likewise.
+	* doc/posix-functions/unlink.texi: Likewise.
+	* doc/posix-functions/unlinkat.texi: Likewise.
+	* doc/posix-functions/utime.texi: Likewise.
+	* doc/posix-functions/utimensat.texi: Likewise.
+	* doc/posix-functions/utimes.texi: Likewise.
+	* doc/posix-headers/stdint.texi: Likewise.
+	* doc/glibc-functions/futimesat.texi: Likewise.
+	* doc/glibc-functions/lutimes.texi: Likewise.
+	* doc/glibc-functions/memmem.texi: Likewise.
+
 2018-07-23  Werner LEMBERG  <wl@gnu.org>
 
 	doc: Avoid some overfull lines in the TeX output.
--- a/doc/alloca-opt.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/alloca-opt.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -9,14 +9,14 @@
 @c Texts.  A copy of the license is included in the ``GNU Free
 @c Documentation License'' file as part of this distribution.
 
-The alloca-opt module provides for a function @code{alloca} which allocates
+The @code{alloca-opt} module provides for a function @code{alloca} which allocates
 memory on the stack, where the system allows it. A memory block allocated with
 @code{alloca} exists only until the function that calls @code{alloca} returns
 or exits abruptly.
 
 There are a few systems where this is not possible: HP-UX systems, and some
 other platforms when the C++ compiler is used. On these platforms the
-alloca-opt module provides no replacement, just a preprocessor macro
+@code{alloca-opt} module provides no replacement, just a preprocessor macro
 HAVE_ALLOCA.
 
 The user can @code{#include <alloca.h>} on all platforms, and use
--- a/doc/alloca.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/alloca.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -9,7 +9,7 @@
 @c Texts.  A copy of the license is included in the ``GNU Free
 @c Documentation License'' file as part of this distribution.
 
-The alloca module provides for a function @code{alloca} which allocates
+The @code{alloca} module provides for a function @code{alloca} which allocates
 memory on the stack, where the system allows it. A memory block allocated with
 @code{alloca} exists only until the function that calls @code{alloca} returns
 or exits abruptly.
--- a/doc/glibc-functions/futimesat.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/glibc-functions/futimesat.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -24,5 +24,5 @@
      : futimens(fd, times)
 @end example
 
-@noindent or the gnulib module fdutimensat, instead.
+@noindent or the gnulib module @code{fdutimensat}, instead.
 @end itemize
--- a/doc/glibc-functions/lutimes.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/glibc-functions/lutimes.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -16,7 +16,7 @@
 @item
 This function cannot set full timestamp resolution.  Use
 @code{utimensat(AT_FDCWD,file,times,AT_SYMLINK_NOFOLLOW)}, or the
-gnulib module utimens, instead.
+gnulib module @code{utimens}, instead.
 @item
 The mere act of using @code{lstat} modifies the access time of
 symlinks on some platforms, so @code{lutimes} can only effectively
--- a/doc/glibc-functions/memmem.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/glibc-functions/memmem.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -5,7 +5,7 @@
 Gnulib module: memmem or memmem-simple
 
 Both modules implement the same replacement for the @code{memmem} function
-with the memmem module providing a replacement on more platforms where
+with the @code{memmem} module providing a replacement on more platforms where
 the existing @code{memmem} function has a quadratic worst-case complexity.
 
 Portability problems fixed by either Gnulib module @code{memmem-simple}
--- a/doc/posix-functions/freopen.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/freopen.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -37,6 +37,6 @@
 @item
 Applications should not assume that @code{fileno(f)} will be the same
 before and after a call to @code{freopen(name,mode,f)}.  However, the
-module freopen-safer can at least protect @code{stdin}, @code{stdout},
+module @code{freopen-safer} can at least protect @code{stdin}, @code{stdout},
 and @code{stderr}.
 @end itemize
--- a/doc/posix-functions/open.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/open.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -6,7 +6,7 @@
 
 Gnulib module: open, fchdir
 
-Portability problems fixed by the Gnulib module open:
+Portability problems fixed by the Gnulib module @code{open}:
 @itemize
 @item
 Some platforms do not support @code{O_CLOEXEC}:
@@ -28,7 +28,7 @@
 recognize the @file{/dev/null} filename.
 @end itemize
 
-Portability problems fixed by the Gnulib module fchdir:
+Portability problems fixed by the Gnulib module @code{fchdir}:
 @itemize
 @item
 On Windows platforms (excluding Cygwin), this function fails to open a
--- a/doc/posix-functions/readlink.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/readlink.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -37,6 +37,6 @@
 matches the length.  Furthermore, AIX 5.1 and HP-UX 11 set
 @code{errno} to @code{ERANGE} rather than returning truncated
 contents, and Linux sets @code{errno} to @code{EINVAL} if the
-requested length is zero.  Use the gnulib module areadlink for
+requested length is zero.  Use the gnulib module @code{areadlink} for
 improved ability to read symlink contents.
 @end itemize
--- a/doc/posix-functions/readlinkat.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/readlinkat.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -42,6 +42,6 @@
 matches the length.  Furthermore, AIX 5.1 and HP-UX 11 set
 @code{errno} to @code{ERANGE} rather than returning truncated
 contents, and Linux sets @code{errno} to @code{EINVAL} if the
-requested length is zero.  Use the gnulib module areadlink for
+requested length is zero.  Use the gnulib module @code{areadlink} for
 improved ability to read symlink contents.
 @end itemize
--- a/doc/posix-functions/stderr.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/stderr.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -15,7 +15,7 @@
 @item
 stderr is created in 32-bit mode instead of 64-bit mode: Cygwin 1.5.x.
 One workaround is to use freopen(NULL, ``r+'', stderr) on Cygwin 1.5.21
-or newer.  Another is to use the gnulib ftello module and do
+or newer.  Another is to use the gnulib @code{ftello} module and do
 ftello(stderr).
 @item
 POSIX states that a setuid application can guarantee that fd 2 is
--- a/doc/posix-functions/stdout.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/stdout.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -15,7 +15,7 @@
 @item
 stdout is created in 32-bit mode instead of 64-bit mode: Cygwin 1.5.x.
 One workaround is to use freopen(NULL, ``w'', stdout) on Cygwin 1.5.21
-or newer.  Another is to use the gnulib ftello module and do
+or newer.  Another is to use the gnulib @code{ftello} module and do
 ftello(stdout).
 @item
 POSIX states that a setuid application can guarantee that fd 1 is
--- a/doc/posix-functions/unlink.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/unlink.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -26,7 +26,7 @@
 has the ability to unlink directories, POSIX requires that
 @code{unlink("symlink-to-dir/")} remove @file{dir} and leave
 @file{symlink-to-dir} dangling; this behavior is counter-intuitive.
-The gnulib module unlinkdir can help determine whether code must be
+The gnulib module @code{unlinkdir} can help determine whether code must be
 cautious of unlinking directories.
 @item
 Removing an open file is non-portable: On Unix this allows the programs that
--- a/doc/posix-functions/unlinkat.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/unlinkat.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -44,7 +44,7 @@
 has the ability to unlink directories, POSIX requires that
 @code{unlinkat(fd,"symlink-to-dir/",0)} remove @file{dir} and leave
 @file{symlink-to-dir} dangling; this behavior is counter-intuitive.
-The gnulib module unlinkdir can help determine whether code must be
+The gnulib module @code{unlinkdir} can help determine whether code must be
 cautious of unlinking directories.
 @item
 Removing an open file is non-portable: On Unix this allows the programs that
--- a/doc/posix-functions/utime.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/utime.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -28,6 +28,6 @@
 Solaris 9.
 @item
 This function cannot set full timestamp resolution.  Use
-@code{utimensat(AT_FDCWD,file,times,0)}, or the gnulib module utimens,
+@code{utimensat(AT_FDCWD,file,times,0)}, or the gnulib module @code{utimens},
 instead.
 @end itemize
--- a/doc/posix-functions/utimensat.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/utimensat.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -56,4 +56,4 @@
 Cygwin 1.5.x.
 @end itemize
 
-The gnulib module fdutimensat provides a similar interface.
+The gnulib module @code{fdutimensat} provides a similar interface.
--- a/doc/posix-functions/utimes.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-functions/utimes.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -25,7 +25,7 @@
 @item
 This function cannot set full timestamp resolution.  In particular,
 some platforms incorrectly round rather than truncate.  Use
-@code{utimensat(AT_FDCWD,file,times,0)}, or the gnulib module utimens,
+@code{utimensat(AT_FDCWD,file,times,0)}, or the gnulib module @code{utimens},
 instead.
 @item
 On some platforms, @code{utimes (file, NULL)} fails to set the
--- a/doc/posix-headers/stdint.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/posix-headers/stdint.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -66,7 +66,7 @@
 @code{#if}-time.
 @end itemize
 
-The stdint.h module uses @code{#include_next}.  If you wish to install
+The @code{stdint} module uses @code{#include_next}.  If you wish to install
 the generated stdint.h file under another name, typically in order to
 be able to use some of the types defined by stdint.h in your public
 header file, you could use the following Makefile.am-snippet:
--- a/doc/quote.texi	Tue Jul 24 02:46:14 2018 +0200
+++ b/doc/quote.texi	Tue Jul 24 03:31:36 2018 +0200
@@ -39,6 +39,6 @@
 need to use @code{quote_n}.
 
 @findex quotearg_alloc
-Also, the quote module is not suited for multithreaded applications.
+Also, the @code{quote} module is not suited for multithreaded applications.
 In that case, you have to use @code{quotearg_alloc}, defined in the
 @samp{quotearg} module, which is decidedly less convenient.