]> git.ipfire.org Git - thirdparty/glibc.git/commit
manual: Convert @tables of variables to @vtables.
authorRical Jasan <ricaljasan@pacific.net>
Wed, 21 Dec 2016 09:36:58 +0000 (01:36 -0800)
committerRical Jasan <ricaljasan@pacific.net>
Wed, 21 Dec 2016 09:36:58 +0000 (01:36 -0800)
commit2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a
tree9bc8f8d16e9de019dc03e46ab994f9f94005b5ca
parent41c67149b94676347b0068a902058f130e3e88e6
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.
17 files changed:
ChangeLog
manual/arith.texi
manual/filesys.texi
manual/llio.texi
manual/memory.texi
manual/nss.texi
manual/process.texi
manual/resource.texi
manual/search.texi
manual/signal.texi
manual/socket.texi
manual/stdio.texi
manual/sysinfo.texi
manual/syslog.texi
manual/terminal.texi
manual/time.texi
manual/users.texi