]> Savannah Git Hosting - gnulib.git/commitdiff
doc: For module names, use texinfo markup @code{} or @samp{}.
authorBruno Haible <bruno@clisp.org>
Tue, 24 Jul 2018 01:31:36 +0000 (03:31 +0200)
committerBruno Haible <bruno@clisp.org>
Tue, 24 Jul 2018 01:31:36 +0000 (03:31 +0200)
* 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.

19 files changed:
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

index 79821f90d5f4b2c670e77a3f296b28f9b94f915d..80dc2c244c0fadf9db09a9c94cfe436319d448b2 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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.
index 379670c1fea9b627b11654ecc16dfeb198af4db4..81cf13ed4b3f0611ff25ee86bd2977759a17a935 100644 (file)
@@ -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
index 04c9cb3af6609639f9b2d9844b2fe8b65a3d776d..546a0dc133be7bb183ae9e716895e143c546e95f 100644 (file)
@@ -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.
index ac7bb615da44b0f0f7ed259a791c5146a30f12a5..8d1760a69555cb54a50038a5045d4449445c29ee 100644 (file)
@@ -24,5 +24,5 @@ file ? utimensat(fd, file, times, 0)
      : futimens(fd, times)
 @end example
 
-@noindent or the gnulib module fdutimensat, instead.
+@noindent or the gnulib module @code{fdutimensat}, instead.
 @end itemize
index d2603425dd0ae6c9dc4174de0599e4097f387f99..19a17e7b2fcd67fdf75f24361813f1593c47c479 100644 (file)
@@ -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
index 017da71d0a97b4cc4f0f30ab90f8f4c7138b8065..bdab0e0c586895c25e00847b78c79742fae50eb1 100644 (file)
@@ -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}
index 08d52cac8afbd4b1ff1cdb7c7d4c450ed923b97b..93f5e176a93d0ba584576a0c9cf0818165e9525e 100644 (file)
@@ -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
index 7e9df261d5bfaececf54792e11f5ea5c91764992..6cf22c2f62dc95daa41fa092b8ce6051289ffdc8 100644 (file)
@@ -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
index c1279ddef443b2b3d872b7aceabdbddce92dd5c5..98bf1bd02910ca575d9fa296df56edda8d833624 100644 (file)
@@ -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
index 10ea3dce2c4d5a48d25caf1f6954f9ab37c3f4ff..f8c2bbd8bd1d6989c7247f7442ebe99c8ef692f5 100644 (file)
@@ -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
index 10a4e54e9f85c7f7d78adc845a91870f4c129b99..b0ed1736781399203c873bb3d9c3c57200301843 100644 (file)
@@ -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
index 208dafafef12034c09a05f5656042f4aa4364ab3..891237342162399f711a577f6f75207d0d7c05fb 100644 (file)
@@ -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
index 171e9facd6abc7f2eac9ea39b504eca63ff24fe0..9bf7cfdc52be2fc942728d427fbeb878bb0d4212 100644 (file)
@@ -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
index 85764a6d61d525c4da0d01db63d077a71e9ace67..de9d517cee598491c62b9032a45c2486c95a3ac3 100644 (file)
@@ -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
index 99a9b97ef7ddd78ee515afec4d26d6cf969574e2..23c74d14a205043871b12c8f988e6cff7bcc44a4 100644 (file)
@@ -28,6 +28,6 @@ On some platforms, this function mis-handles trailing slash:
 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
index 4993c10a853bd339c5b911f4a285a54be692eb1b..d0590bb01c41373e2a7f77de3df115861f27dc40 100644 (file)
@@ -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.
index de53795125fe85c7a3476c0c68a892a566681f02..90a453d8e9eae1c2d4ca9f699ea2b5d73118b74a 100644 (file)
@@ -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
-@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
index d8b83956085f65c601af167b70cf5014aba0d104..87e5306b8334df846d1ed80e021aabb865dc4f8f 100644 (file)
@@ -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:
index b8102698e7d81bdb4ab4053b49edc88358935cfb..6a15967f24b27402dfeea4b383b6f940a5551b36 100644 (file)
@@ -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.