about summary refs log tree commit diff
path: root/manual/sysinfo.texi
diff options
context:
space:
mode:
authorRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
committerRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
commit2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a (patch)
tree9bc8f8d16e9de019dc03e46ab994f9f94005b5ca /manual/sysinfo.texi
parent41c67149b94676347b0068a902058f130e3e88e6 (diff)
downloadglibc-2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a.tar.gz
glibc-2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a.tar.xz
glibc-2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a.zip
manual: Convert @tables of variables to @vtables.
Texinfo @vindex commands add entries to the Variable and Constant
Macro Index.  Similarly, @items in @vtables are automatically indexed.
A number of @tables exist where all @items are @vindexed or all @items
are variables, but not indexed, suggesting an optimization by
converting such @tables to @vtables and dropping the @vindex.

Using a @vtable provides a context for processing @items whereby it
can be known the @items should have header and standards annotations.
This commit converts @tables of such @items to @vtables in order to
establish a framework for automated processing.

A pleasant consequence of these changes is that @items previously
lacking a @vindex are present in the Variable and Constant Macro Index
now.  @vindex entries previously detected by summary.awk will still be
detected as @items with appropriate annotations.

The @vtable of the NSS databases is converted to a @table because 1)
those @items are not variables (and will no longer appear in the
Variable and Constant Macro Index) and 2) they do not need header and
standards annotations, so the incorrect context is fixed.

	* manual/nss.texi: Change incorrect @vtable to @table.
	* manual/arith.texi: Convert @tables of variables to @vtables
	and remove unnecessary indexing.
	* manual/filesys.texi: Likewise.
	* manual/llio.texi: Likewise.
	* manual/memory.texi: Likewise.
	* manual/process.texi: Likewise.
	* manual/resource.texi: Likewise.
	* manual/search.texi: Likewise.
	* manual/signal.texi: Likewise.
	* manual/socket.texi: Likewise.
	* manual/stdio.texi: Likewise.
	* manual/sysinfo.texi: Likewise.
	* manual/syslog.texi: Likewise.
	* manual/terminal.texi: Likewise.
	* manual/time.texi: Likewise.
	* manual/users.texi: Likewise.
Diffstat (limited to 'manual/sysinfo.texi')
-rw-r--r--manual/sysinfo.texi8
1 files changed, 4 insertions, 4 deletions
diff --git a/manual/sysinfo.texi b/manual/sysinfo.texi
index 66b7f3d898..9a8b79d66b 100644
--- a/manual/sysinfo.texi
+++ b/manual/sysinfo.texi
@@ -912,7 +912,7 @@ file accesses via @code{ioctl}.
 @var{options} is a bit string with bit fields defined using the
 following mask and masked value macros:
 
-@table @code
+@vtable @code
 @item MS_MGC_MASK
 This multibit field contains a magic number.  If it does not have the value
 @code{MS_MGC_VAL}, @code{mount} assumes all the following bits are zero and
@@ -962,7 +962,7 @@ when the directories are accessed while the filesystem in mounted.
 @c there is also S_QUOTA Linux fs.h (mount.h still uses its former name
 @c S_WRITE), but I can't see what it does.  Turns on quotas, I guess.
 
-@end table
+@end vtable
 
 Any bits not covered by the above masks should be set off; otherwise,
 results are undefined.
@@ -1066,7 +1066,7 @@ the same.  Specify either as the string @var{file}.
 @var{flags} contains the one-bit field identified by the following
 mask macro:
 
-@table @code
+@vtable @code
 
 @item MNT_FORCE
 This bit on means to force the unmounting even if the filesystem is
@@ -1074,7 +1074,7 @@ busy, by making it unbusy first.  If the bit is off and the filesystem is
 busy, @code{umount2} fails with @code{errno} = @code{EBUSY}.  Depending
 on the filesystem, this may override all, some, or no busy conditions.
 
-@end table
+@end vtable
 
 All other bits in @var{flags} should be set to zero; otherwise, the result
 is undefined.