about summary refs log tree commit diff
path: root/manual/stdio.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/stdio.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/stdio.texi')
-rw-r--r--manual/stdio.texi7
1 files changed, 2 insertions, 5 deletions
diff --git a/manual/stdio.texi b/manual/stdio.texi
index 355c56341a..dbb21ca4a9 100644
--- a/manual/stdio.texi
+++ b/manual/stdio.texi
@@ -4526,25 +4526,22 @@ These three aliases for the @samp{SEEK_@dots{}} constants exist for the
 sake of compatibility with older BSD systems.  They are defined in two
 different header files: @file{fcntl.h} and @file{sys/file.h}.
 
-@table @code
+@vtable @code
 @comment sys/file.h
 @comment BSD
 @item L_SET
-@vindex L_SET
 An alias for @code{SEEK_SET}.
 
 @comment sys/file.h
 @comment BSD
 @item L_INCR
-@vindex L_INCR
 An alias for @code{SEEK_CUR}.
 
 @comment sys/file.h
 @comment BSD
 @item L_XTND
-@vindex L_XTND
 An alias for @code{SEEK_END}.
-@end table
+@end vtable
 
 @node Portable Positioning
 @section Portable File-Position Functions