bug-gnulib
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

doc: tweak markup of module names


From: Bruno Haible
Subject: doc: tweak markup of module names
Date: Tue, 24 Jul 2018 03:33:16 +0200
User-agent: KMail/5.1.3 (Linux/4.4.0-130-generic; KDE/5.18.0; x86_64; ; )

2018-07-23  Bruno Haible  <address@hidden>

        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.

diff --git a/doc/alloca-opt.texi b/doc/alloca-opt.texi
index 379670c..81cf13e 100644
--- a/doc/alloca-opt.texi
+++ b/doc/alloca-opt.texi
@@ -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
address@hidden module provides no replacement, just a preprocessor macro
 HAVE_ALLOCA.
 
 The user can @code{#include <alloca.h>} on all platforms, and use
diff --git a/doc/alloca.texi b/doc/alloca.texi
index 04c9cb3..546a0dc 100644
--- a/doc/alloca.texi
+++ b/doc/alloca.texi
@@ -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.
diff --git a/doc/glibc-functions/futimesat.texi 
b/doc/glibc-functions/futimesat.texi
index ac7bb61..8d1760a 100644
--- a/doc/glibc-functions/futimesat.texi
+++ b/doc/glibc-functions/futimesat.texi
@@ -24,5 +24,5 @@ file ? utimensat(fd, file, times, 0)
      : futimens(fd, times)
 @end example
 
address@hidden or the gnulib module fdutimensat, instead.
address@hidden or the gnulib module @code{fdutimensat}, instead.
 @end itemize
diff --git a/doc/glibc-functions/lutimes.texi b/doc/glibc-functions/lutimes.texi
index d260342..19a17e7 100644
--- a/doc/glibc-functions/lutimes.texi
+++ b/doc/glibc-functions/lutimes.texi
@@ -16,7 +16,7 @@ Mac OS X 10.4, OpenBSD 3.8, Minix 3.1.8, AIX 5.1, HP-UX 11, 
IRIX 6.5, OSF/1 5.1,
 @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
diff --git a/doc/glibc-functions/memmem.texi b/doc/glibc-functions/memmem.texi
index 017da71d..bdab0e0 100644
--- a/doc/glibc-functions/memmem.texi
+++ b/doc/glibc-functions/memmem.texi
@@ -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}
diff --git a/doc/posix-functions/freopen.texi b/doc/posix-functions/freopen.texi
index 08d52ca..93f5e17 100644
--- a/doc/posix-functions/freopen.texi
+++ b/doc/posix-functions/freopen.texi
@@ -37,6 +37,6 @@ HP-UX 11.00, Solaris 9, Irix 5.3.
 @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
diff --git a/doc/posix-functions/open.texi b/doc/posix-functions/open.texi
index 7e9df26..6cf22c2 100644
--- a/doc/posix-functions/open.texi
+++ b/doc/posix-functions/open.texi
@@ -6,7 +6,7 @@ POSIX specification:@* 
@url{http://www.opengroup.org/onlinepubs/9699919799/funct
 
 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 @@ On Windows platforms (excluding Cygwin), this function does 
usually not
 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
diff --git a/doc/posix-functions/readlink.texi 
b/doc/posix-functions/readlink.texi
index c1279dd..98bf1bd 100644
--- a/doc/posix-functions/readlink.texi
+++ b/doc/posix-functions/readlink.texi
@@ -37,6 +37,6 @@ no indication if symlink contents were truncated if the 
return value
 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
diff --git a/doc/posix-functions/readlinkat.texi 
b/doc/posix-functions/readlinkat.texi
index 10ea3dc..f8c2bbd 100644
--- a/doc/posix-functions/readlinkat.texi
+++ b/doc/posix-functions/readlinkat.texi
@@ -42,6 +42,6 @@ no indication if symlink contents were truncated if the 
return value
 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
diff --git a/doc/posix-functions/stderr.texi b/doc/posix-functions/stderr.texi
index 10a4e54..b0ed173 100644
--- a/doc/posix-functions/stderr.texi
+++ b/doc/posix-functions/stderr.texi
@@ -15,7 +15,7 @@ Portability problems not fixed by Gnulib:
 @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
diff --git a/doc/posix-functions/stdout.texi b/doc/posix-functions/stdout.texi
index 208dafa..8912373 100644
--- a/doc/posix-functions/stdout.texi
+++ b/doc/posix-functions/stdout.texi
@@ -15,7 +15,7 @@ Portability problems not fixed by Gnulib:
 @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
diff --git a/doc/posix-functions/unlink.texi b/doc/posix-functions/unlink.texi
index 171e9fa..9bf7cfd 100644
--- a/doc/posix-functions/unlink.texi
+++ b/doc/posix-functions/unlink.texi
@@ -26,7 +26,7 @@ not always the POSIX value of @code{EPERM}.  Meanwhile, if a 
process
 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
diff --git a/doc/posix-functions/unlinkat.texi 
b/doc/posix-functions/unlinkat.texi
index 85764a6..de9d517 100644
--- a/doc/posix-functions/unlinkat.texi
+++ b/doc/posix-functions/unlinkat.texi
@@ -44,7 +44,7 @@ not always the POSIX value of @code{EPERM}.  Meanwhile, if a 
process
 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
diff --git a/doc/posix-functions/utime.texi b/doc/posix-functions/utime.texi
index 99a9b97..23c74d1 100644
--- a/doc/posix-functions/utime.texi
+++ b/doc/posix-functions/utime.texi
@@ -28,6 +28,6 @@ On some platforms, this function mis-handles trailing slash:
 Solaris 9.
 @item
 This function cannot set full timestamp resolution.  Use
address@hidden(AT_FDCWD,file,times,0)}, or the gnulib module utimens,
address@hidden(AT_FDCWD,file,times,0)}, or the gnulib module @code{utimens},
 instead.
 @end itemize
diff --git a/doc/posix-functions/utimensat.texi 
b/doc/posix-functions/utimensat.texi
index 4993c10..d0590bb 100644
--- a/doc/posix-functions/utimensat.texi
+++ b/doc/posix-functions/utimensat.texi
@@ -56,4 +56,4 @@ effectively change directory modification time:
 Cygwin 1.5.x.
 @end itemize
 
-The gnulib module fdutimensat provides a similar interface.
+The gnulib module @code{fdutimensat} provides a similar interface.
diff --git a/doc/posix-functions/utimes.texi b/doc/posix-functions/utimes.texi
index de53795..90a453d 100644
--- a/doc/posix-functions/utimes.texi
+++ b/doc/posix-functions/utimes.texi
@@ -25,7 +25,7 @@ FreeBSD 7.2, Solaris 9.
 @item
 This function cannot set full timestamp resolution.  In particular,
 some platforms incorrectly round rather than truncate.  Use
address@hidden(AT_FDCWD,file,times,0)}, or the gnulib module utimens,
address@hidden(AT_FDCWD,file,times,0)}, or the gnulib module @code{utimens},
 instead.
 @item
 On some platforms, @code{utimes (file, NULL)} fails to set the
diff --git a/doc/posix-headers/stdint.texi b/doc/posix-headers/stdint.texi
index d8b8395..87e5306 100644
--- a/doc/posix-headers/stdint.texi
+++ b/doc/posix-headers/stdint.texi
@@ -66,7 +66,7 @@ To work around these problems, compute the value of 
expressions like
 @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:
diff --git a/doc/quote.texi b/doc/quote.texi
index b810269..6a15967 100644
--- a/doc/quote.texi
+++ b/doc/quote.texi
@@ -39,6 +39,6 @@ Hence if you need more than one thing quoted at the same 
time, you
 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.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]