about summary refs log tree commit diff
path: root/manual/socket.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/socket.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/socket.texi')
-rw-r--r--manual/socket.texi17
1 files changed, 4 insertions, 13 deletions
diff --git a/manual/socket.texi b/manual/socket.texi
index 24b4563562..25d9276d7c 100644
--- a/manual/socket.texi
+++ b/manual/socket.texi
@@ -325,11 +325,10 @@ Each address format has a symbolic name which starts with @samp{AF_}.
 Each of them corresponds to a @samp{PF_} symbol which designates the
 corresponding namespace.  Here is a list of address format names:
 
-@table @code
+@vtable @code
 @comment sys/socket.h
 @comment POSIX
 @item AF_LOCAL
-@vindex AF_LOCAL
 This designates the address format that goes with the local namespace.
 (@code{PF_LOCAL} is the name of that namespace.)  @xref{Local Namespace
 Details}, for information about this address format.
@@ -337,7 +336,6 @@ Details}, for information about this address format.
 @comment sys/socket.h
 @comment BSD, Unix98
 @item AF_UNIX
-@vindex AF_UNIX
 This is a synonym for @code{AF_LOCAL}.  Although @code{AF_LOCAL} is
 mandated by POSIX.1g, @code{AF_UNIX} is portable to more systems.
 @code{AF_UNIX} was the traditional name stemming from BSD, so even most
@@ -348,14 +346,12 @@ vs. @code{PF_LOCAL}).
 @comment sys/socket.h
 @comment GNU
 @item AF_FILE
-@vindex AF_FILE
 This is another synonym for @code{AF_LOCAL}, for compatibility.
 (@code{PF_FILE} is likewise a synonym for @code{PF_LOCAL}.)
 
 @comment sys/socket.h
 @comment BSD
 @item AF_INET
-@vindex AF_INET
 This designates the address format that goes with the Internet
 namespace.  (@code{PF_INET} is the name of that namespace.)
 @xref{Internet Address Formats}.
@@ -369,14 +365,13 @@ This is similar to @code{AF_INET}, but refers to the IPv6 protocol.
 @comment sys/socket.h
 @comment BSD
 @item AF_UNSPEC
-@vindex AF_UNSPEC
 This designates no particular address format.  It is used only in rare
 cases, such as to clear out the default destination address of a
 ``connected'' datagram socket.  @xref{Sending Datagrams}.
 
 The corresponding namespace designator symbol @code{PF_UNSPEC} exists
 for completeness, but there is no reason to use it in a program.
-@end table
+@end vtable
 
 @file{sys/socket.h} defines symbols starting with @samp{AF_} for many
 different kinds of networks, most or all of which are not actually
@@ -1436,33 +1431,29 @@ with other systems.)
 
 Here are the error codes that you may find in @code{h_errno}:
 
-@table @code
+@vtable @code
 @comment netdb.h
 @comment BSD
 @item HOST_NOT_FOUND
-@vindex HOST_NOT_FOUND
 No such host is known in the database.
 
 @comment netdb.h
 @comment BSD
 @item TRY_AGAIN
-@vindex TRY_AGAIN
 This condition happens when the name server could not be contacted.  If
 you try again later, you may succeed then.
 
 @comment netdb.h
 @comment BSD
 @item NO_RECOVERY
-@vindex NO_RECOVERY
 A non-recoverable error occurred.
 
 @comment netdb.h
 @comment BSD
 @item NO_ADDRESS
-@vindex NO_ADDRESS
 The host database contains an entry for the name, but it doesn't have an
 associated Internet address.
-@end table
+@end vtable
 
 The lookup functions above all have one thing in common: they are not
 reentrant and therefore unusable in multi-threaded applications.