about summary refs log tree commit diff
path: root/manual/users.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/users.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/users.texi')
-rw-r--r--manual/users.texi27
1 files changed, 4 insertions, 23 deletions
diff --git a/manual/users.texi b/manual/users.texi
index 0d94db1cdb..433eeadf3d 100644
--- a/manual/users.texi
+++ b/manual/users.texi
@@ -1069,68 +1069,58 @@ The following macros are defined for use as values for the
 @code{ut_type} member of the @code{utmp} structure.  The values are
 integer constants.
 
-@table @code
+@vtable @code
 @comment utmp.h
 @comment SVID
-@vindex EMPTY
 @item EMPTY
 This macro is used to indicate that the entry contains no valid user
 accounting information.
 
 @comment utmp.h
 @comment SVID
-@vindex RUN_LVL
 @item RUN_LVL
 This macro is used to identify the system's runlevel.
 
 @comment utmp.h
 @comment SVID
-@vindex BOOT_TIME
 @item BOOT_TIME
 This macro is used to identify the time of system boot.
 
 @comment utmp.h
 @comment SVID
-@vindex OLD_TIME
 @item OLD_TIME
 This macro is used to identify the time when the system clock changed.
 
 @comment utmp.h
 @comment SVID
-@vindex NEW_TIME
 @item NEW_TIME
 This macro is used to identify the time after the system clock changed.
 
 @comment utmp.h
 @comment SVID
-@vindex INIT_PROCESS
 @item INIT_PROCESS
 This macro is used to identify a process spawned by the init process.
 
 @comment utmp.h
 @comment SVID
-@vindex LOGIN_PROCESS
 @item LOGIN_PROCESS
 This macro is used to identify the session leader of a logged in user.
 
 @comment utmp.h
 @comment SVID
-@vindex USER_PROCESS
 @item USER_PROCESS
 This macro is used to identify a user process.
 
 @comment utmp.h
 @comment SVID
-@vindex DEAD_PROCESS
 @item DEAD_PROCESS
 This macro is used to identify a terminated process.
 
 @comment utmp.h
 @comment SVID
-@vindex ACCOUNTING
 @item ACCOUNTING
 ???
-@end table
+@end vtable
 
 The size of the @code{ut_line}, @code{ut_id}, @code{ut_user} and
 @code{ut_host} arrays can be found using the @code{sizeof} operator.
@@ -1547,62 +1537,53 @@ The following macros are defined for use as values for the
 integer constants and are, in @theglibc{}, identical to the
 definitions in @file{utmp.h}.
 
-@table @code
+@vtable @code
 @comment utmpx.h
 @comment XPG4.2
-@vindex EMPTY
 @item EMPTY
 This macro is used to indicate that the entry contains no valid user
 accounting information.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex RUN_LVL
 @item RUN_LVL
 This macro is used to identify the system's runlevel.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex BOOT_TIME
 @item BOOT_TIME
 This macro is used to identify the time of system boot.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex OLD_TIME
 @item OLD_TIME
 This macro is used to identify the time when the system clock changed.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex NEW_TIME
 @item NEW_TIME
 This macro is used to identify the time after the system clock changed.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex INIT_PROCESS
 @item INIT_PROCESS
 This macro is used to identify a process spawned by the init process.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex LOGIN_PROCESS
 @item LOGIN_PROCESS
 This macro is used to identify the session leader of a logged in user.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex USER_PROCESS
 @item USER_PROCESS
 This macro is used to identify a user process.
 
 @comment utmpx.h
 @comment XPG4.2
-@vindex DEAD_PROCESS
 @item DEAD_PROCESS
 This macro is used to identify a terminated process.
-@end table
+@end vtable
 
 The size of the @code{ut_line}, @code{ut_id} and @code{ut_user} arrays
 can be found using the @code{sizeof} operator.