public inbox for libc-alpha@sourceware.org
 help / color / mirror / Atom feed
From: Rical Jasan <ricaljasan@pacific.net>
To: libc-alpha@sourceware.org
Cc: Joseph Myers <joseph@codesourcery.com>,
	Carlos O'Donell <carlos@redhat.com>,
	Michael Kerrisk <mtk.manpages@gmail.com>
Subject: [PATCH v3 5/7] manual: Convert @tables of annotated @items to @vtables.
Date: Tue, 16 May 2017 10:28:00 -0000	[thread overview]
Message-ID: <04419bff545d1647a0c23b72b3498c9f1b04beab.1494920105.git.ricaljasan@pacific.net> (raw)
In-Reply-To: <cover.1494920105.git.ricaljasan@pacific.net>

[-- Attachment #1: Type: text/plain, Size: 885 bytes --]

The conversion script will convert these annotations, but the
replacement Summary-generation script won't catch them because @items
in @tables are not generally considered annotatable, causing them to
be skipped over (or cause errors).  Using @vtable ensures their
continued presence in the Summary, with the added benefit that Texinfo
will also automatically include them in the Variable and Constant
Macro index now.

	* manual/conf.texi: Convert @tables of annotated @items to
	@vtables.
	* manual/lang.texi: Likewise.
	* manual/pattern.texi: Likewise.
	* manual/resource.texi: Likewise.
	* manual/socket.texi: Likewise.
---
 manual/conf.texi     | 20 ++++++++++----------
 manual/lang.texi     |  8 ++++----
 manual/pattern.texi  | 28 ++++++++++++++--------------
 manual/resource.texi |  4 ++--
 manual/socket.texi   |  4 ++--
 5 files changed, 32 insertions(+), 32 deletions(-)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0005-manual-Convert-tables-of-annotated-items-to-vtables.patch --]
[-- Type: text/x-patch; name="0005-manual-Convert-tables-of-annotated-items-to-vtables.patch", Size: 9491 bytes --]

diff --git a/manual/conf.texi b/manual/conf.texi
index 1fe75c293f..6700e86539 100644
--- a/manual/conf.texi
+++ b/manual/conf.texi
@@ -1030,7 +1030,7 @@ limit parameters.  The significance of these values is that you can
 safely push to these limits without checking whether the particular
 system you are using can go that far.
 
-@table @code
+@vtable @code
 @comment limits.h
 @comment POSIX.1
 @item _POSIX_AIO_LISTIO_MAX
@@ -1103,7 +1103,7 @@ for the maximum length of a time zone name.  Its value is @code{3}.
 The value of this macro is the most restrictive limit permitted by POSIX
 for the numbers used in the @samp{\@{@var{min},@var{max}\@}} construct
 in a regular expression.  Its value is @code{255}.
-@end table
+@end vtable
 
 @node Limits for Files
 @section Limits on File System Capacity
@@ -1271,7 +1271,7 @@ system you are using can go that far.  In most cases @gnusystems{} do not
 have these strict limitations.  The actual limit should be requested if
 necessary.
 
-@table @code
+@vtable @code
 @comment limits.h
 @comment POSIX.1
 @item _POSIX_LINK_MAX
@@ -1340,7 +1340,7 @@ Minimum recommended file transfer size.
 @comment POSIX.1
 @item POSIX_REC_XFER_ALIGN
 Recommended file transfer buffer alignment.
-@end table
+@end vtable
 
 @node Pathconf
 @section Using @code{pathconf}
@@ -1409,7 +1409,7 @@ Here are the symbolic constants that you can use as the @var{parameter}
 argument to @code{pathconf} and @code{fpathconf}.  The values are all
 integer constants.
 
-@table @code
+@vtable @code
 @comment unistd.h
 @comment POSIX.1
 @item _PC_LINK_MAX
@@ -1494,7 +1494,7 @@ Inquire about the value of @code{POSIX_REC_MIN_XFER_SIZE}.
 @comment POSIX.1
 @item _PC_REC_XFER_ALIGN
 Inquire about the value of @code{POSIX_REC_XFER_ALIGN}.
-@end table
+@end vtable
 
 @strong{Portability Note:} On some systems, @theglibc{} does not
 enforce @code{_PC_NAME_MAX} or @code{_PC_PATH_MAX} limits.
@@ -1573,7 +1573,7 @@ The maximum number of weights that can be assigned to an entry of the
 @node Utility Minimums
 @section Minimum Values for Utility Limits
 
-@table @code
+@vtable @code
 @comment limits.h
 @comment POSIX.2
 @item _POSIX2_BC_BASE_MAX
@@ -1627,7 +1627,7 @@ of weights that can be assigned to an entry of the @code{LC_COLLATE}
 category @samp{order} keyword in a locale definition.  Its value is
 @code{2}.  @Theglibc{} does not presently support locale
 definitions.
-@end table
+@end vtable
 
 @node String Parameters
 @section String-Valued Parameters
@@ -1665,7 +1665,7 @@ The value of the @var{parameter} is invalid.
 
 Currently there is just one parameter you can read with @code{confstr}:
 
-@table @code
+@vtable @code
 @comment unistd.h
 @comment POSIX.2
 @item _CS_PATH
@@ -1728,7 +1728,7 @@ to the application if a source is compiled using the
 The returned string specifies which additional flags must be given to
 the lint tool if a source is compiled using the
 @code{_LARGEFILE64_SOURCE} feature select macro; @pxref{Feature Test Macros}.
-@end table
+@end vtable
 
 The way to use @code{confstr} without any arbitrary limit on string size
 is to call it twice: first call it to get the length, allocate the
diff --git a/manual/lang.texi b/manual/lang.texi
index 6281840473..a151c9b690 100644
--- a/manual/lang.texi
+++ b/manual/lang.texi
@@ -661,7 +661,7 @@ of value and sign bits); these macros can also be used in @code{#if}
 preprocessor directives, whereas @code{sizeof} cannot.  The following
 macros are defined in @file{limits.h}.
 
-@table @code
+@vtable @code
 @comment limits.h
 @comment ISO
 @item CHAR_WIDTH
@@ -701,13 +701,13 @@ These are the widths of the types @code{char}, @code{signed char},
 @code{int}, @code{unsigned int}, @code{long int}, @code{unsigned long
 int}, @code{long long int} and @code{unsigned long long int},
 respectively.
-@end table
+@end vtable
 
 Further such macros are defined in @file{stdint.h}.  Apart from those
 for types specified by width (@pxref{Integers}), the following are
 defined.
 
-@table @code
+@vtable @code
 @comment stdint.h
 @comment ISO
 @item INTPTR_WIDTH
@@ -733,7 +733,7 @@ defined.
 These are the widths of the types @code{intptr_t}, @code{uintptr_t},
 @code{ptrdiff_t}, @code{sig_atomic_t}, @code{size_t}, @code{wchar_t}
 and @code{wint_t}, respectively.
-@end table
+@end vtable
 
 @node Range of Type
 @subsection Range of an Integer Type
diff --git a/manual/pattern.texi b/manual/pattern.texi
index 30a76c8160..069a6a23ea 100644
--- a/manual/pattern.texi
+++ b/manual/pattern.texi
@@ -74,7 +74,7 @@ returning nonzero values that are not equal to @code{FNM_NOMATCH}.
 
 These are the available flags for the @var{flags} argument:
 
-@table @code
+@vtable @code
 @comment fnmatch.h
 @comment GNU
 @item FNM_FILE_NAME
@@ -160,7 +160,7 @@ the @var{pattern-list} allows matching the input string.
 The pattern matches if the input string cannot be matched with any of
 the patterns in the @var{pattern-list}.
 @end table
-@end table
+@end vtable
 
 @node Globbing
 @section Globbing
@@ -1143,7 +1143,7 @@ describing the reason for a nonzero value; see @ref{Regexp Cleanup}.
 
 Here are the possible nonzero values that @code{regcomp} can return:
 
-@table @code
+@vtable @code
 @comment regex.h
 @comment POSIX.2
 @item REG_BADBR
@@ -1210,7 +1210,7 @@ One of the endpoints in a range expression was invalid.
 @comment POSIX.2
 @item REG_ESPACE
 @code{regcomp} ran out of memory.
-@end table
+@end vtable
 
 @node Flags for POSIX Regexps
 @subsection Flags for POSIX Regular Expressions
@@ -1218,7 +1218,7 @@ One of the endpoints in a range expression was invalid.
 These are the bit flags that you can use in the @var{cflags} operand when
 compiling a regular expression with @code{regcomp}.
 
-@table @code
+@vtable @code
 @comment regex.h
 @comment POSIX.2
 @item REG_EXTENDED
@@ -1244,7 +1244,7 @@ match after.  Also, don't permit @samp{.} to match a newline, and don't
 permit @samp{[^@dots{}]} to match a newline.
 
 Otherwise, newline acts like any other ordinary character.
-@end table
+@end vtable
 
 @node Matching POSIX Regexps
 @subsection Matching a Compiled POSIX Regular Expression
@@ -1524,7 +1524,7 @@ locales that were in effect when you compiled the regular expression.
 The function @code{regexec} accepts the following flags in the
 @var{eflags} argument:
 
-@table @code
+@vtable @code
 @comment regex.h
 @comment POSIX.2
 @item REG_NOTBOL
@@ -1537,11 +1537,11 @@ precede it.
 @item REG_NOTEOL
 Do not regard the end of the specified string as the end of a line; more
 generally, don't make any assumptions about what text might follow it.
-@end table
+@end vtable
 
 Here are the possible nonzero values that @code{regexec} can return:
 
-@table @code
+@vtable @code
 @comment regex.h
 @comment POSIX.2
 @item REG_NOMATCH
@@ -1551,7 +1551,7 @@ The pattern didn't match the string.  This isn't really an error.
 @comment POSIX.2
 @item REG_ESPACE
 @code{regexec} ran out of memory.
-@end table
+@end vtable
 
 @node Regexp Subexpressions
 @subsection Match Results with Subexpressions
@@ -2013,7 +2013,7 @@ into @code{*@var{word-vector-ptr}}.
 If @code{wordexp} succeeds, it returns 0.  Otherwise, it returns one
 of these error codes:
 
-@table @code
+@vtable @code
 @comment wordexp.h
 @comment POSIX.2
 @item WRDE_BADCHAR
@@ -2045,7 +2045,7 @@ allocate room for.
 There was a syntax error in the input string.  For example, an unmatched
 quoting character is a syntax error.  This error code is also used to
 signal division by zero and overflow in arithmetic expansion.
-@end table
+@end vtable
 @end deftypefun
 
 @comment wordexp.h
@@ -2067,7 +2067,7 @@ This section describes the flags that you can specify in the
 @var{flags} argument to @code{wordexp}.  Choose the flags you want,
 and combine them with the C operator @code{|}.
 
-@table @code
+@vtable @code
 @comment wordexp.h
 @comment POSIX.2
 @item WRDE_APPEND
@@ -2117,7 +2117,7 @@ commands a standard error stream that discards all output.
 @item WRDE_UNDEF
 If the input refers to a shell variable that is not defined, report an
 error.
-@end table
+@end vtable
 
 @node Wordexp Example
 @subsection @code{wordexp} Example
diff --git a/manual/resource.texi b/manual/resource.texi
index 2328045ac0..40160384fc 100644
--- a/manual/resource.texi
+++ b/manual/resource.texi
@@ -32,7 +32,7 @@ This function reports resource usage totals for processes specified by
 
 In most systems, @var{processes} has only two valid values:
 
-@table @code
+@vtable @code
 @comment sys/resource.h
 @comment BSD
 @item RUSAGE_SELF
@@ -42,7 +42,7 @@ Just the current process.
 @comment BSD
 @item RUSAGE_CHILDREN
 All child processes (direct and indirect) that have already terminated.
-@end table
+@end vtable
 
 The return value of @code{getrusage} is zero for success, and @code{-1}
 for failure.
diff --git a/manual/socket.texi b/manual/socket.texi
index 25d9276d7c..21b672badc 100644
--- a/manual/socket.texi
+++ b/manual/socket.texi
@@ -3483,7 +3483,7 @@ this section.
 Here is a table of socket-level option names; all are defined in the
 header file @file{sys/socket.h}.
 
-@table @code
+@vtable @code
 @comment sys/socket.h
 @comment BSD
 @item SO_DEBUG
@@ -3596,7 +3596,7 @@ This option can be used with @code{getsockopt} only.  It is used to reset
 the error status of the socket.  The value is an @code{int}, which represents
 the previous error status.
 @c !!! what is "socket error status"?  this is never defined.
-@end table
+@end vtable
 
 @node Networks Database
 @section Networks Database

  parent reply	other threads:[~2017-05-16 10:28 UTC|newest]

Thread overview: 91+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-06 10:55 [PATCH v2 0/5] Header & Standards Cleanup Rical Jasan
2016-12-06 10:55 ` [PATCH v2 1/5] manual: Refactor header and standards annotations Rical Jasan
2016-12-06 13:49   ` Zack Weinberg
2016-12-06 15:33   ` Joseph Myers
2016-12-19 10:37     ` Rical Jasan
2016-12-19 13:48       ` Joseph Myers
2017-02-07  6:46   ` Rical Jasan
2016-12-06 10:55 ` [PATCH v2 2/5] manual: Convert @tables of variables to @vtables Rical Jasan
2016-12-06 13:50   ` Zack Weinberg
2016-12-06 15:46   ` Joseph Myers
2016-12-07 15:18   ` Nix
2016-12-08  1:38     ` Rical Jasan
2016-12-21 10:08       ` Rical Jasan
2016-12-21 12:42         ` Joseph Myers
2016-12-06 10:55 ` [PATCH v2 4/5] manual: Enforce header and standard requirements Rical Jasan
2016-12-06 10:56 ` [PATCH v2 3/5] manual: Add new header and standards annotations Rical Jasan
2016-12-06 13:23   ` Zack Weinberg
2016-12-06 14:27     ` Andreas Schwab
2016-12-06 16:24     ` Joseph Myers
2016-12-06 19:23       ` Zack Weinberg
2016-12-06 21:42         ` Joseph Myers
2016-12-07 16:32   ` Joseph Myers
2016-12-08  2:56     ` Rical Jasan
2016-12-08 14:02       ` Joseph Myers
2016-12-12  9:01         ` Rical Jasan
2016-12-14 18:18           ` Joseph Myers
2016-12-14 23:30             ` Rical Jasan
2016-12-15  9:58               ` Rical Jasan
2016-12-15 13:01                 ` Joseph Myers
2017-02-07  5:13                   ` Rical Jasan
2017-02-07 16:41                     ` Joseph Myers
2017-02-08  8:50                       ` Rical Jasan
2017-02-08 13:52                         ` Joseph Myers
2017-02-12  6:01                           ` Rical Jasan
2017-04-04  3:58                             ` Rical Jasan
2017-04-04 11:26                               ` Joseph Myers
2017-04-05  3:08                                 ` Rical Jasan
2017-06-16 13:40                                   ` Zack Weinberg
2017-06-16  8:28     ` Rical Jasan
2016-12-06 11:42 ` [PATCH v2 5/5] manual: Clean up miscellaneous standards Rical Jasan
2017-05-16  9:55 ` [PATCH v3 0/7] manual: Header & Standards Cleanup Rical Jasan
2017-05-16  9:55   ` [PATCH v3 2/7] manual: Create empty placeholder macros for @standards Rical Jasan
2017-05-16  9:55   ` [PATCH v3 1/7] manual: Provide one-off standards conversion script Rical Jasan
2017-05-16  9:55   ` [PATCH v3 3/7] manual: Fix up invalid header and standards syntax Rical Jasan
2017-05-16 11:51     ` Joseph Myers
2017-05-17  4:49       ` Rical Jasan
2017-05-17 10:03         ` Joseph Myers
2017-05-18  8:10       ` Rical Jasan
2017-05-16 10:27   ` [PATCH v3 7/7] manual: Replace summary.awk with summary.pl Rical Jasan
2017-05-16 10:28   ` Rical Jasan [this message]
2017-05-16 11:53     ` [PATCH v3 5/7] manual: Convert @tables of annotated @items to @vtables Joseph Myers
2017-05-18  8:11       ` Rical Jasan
2017-05-16 10:28   ` [PATCH v3 6/7] manual: Convert header and standards @comments to @standards Rical Jasan
2017-05-16 10:29   ` [PATCH v3 4/7] manual: Refactor errno @comments Rical Jasan
2017-05-16 11:06     ` Joseph Myers
2017-05-17  4:44       ` Rical Jasan
2017-05-17 13:21         ` Zack Weinberg
2017-05-17 13:31           ` Zack Weinberg
2017-05-18  9:42           ` Rical Jasan
2017-05-18 12:32             ` Zack Weinberg
2017-05-19  9:46               ` Rical Jasan
2017-05-19 20:50                 ` Zack Weinberg
2017-05-19  6:20         ` Rical Jasan
2017-05-18  9:58       ` Rical Jasan
2017-05-19  9:33   ` [PATCH v4 0/5] manual: Header & Standards Cleanup Rical Jasan
2017-05-19  9:33     ` [PATCH v4 2/5] manual: Create empty placeholder macros for @standards Rical Jasan
2017-05-19 21:02       ` Zack Weinberg
2017-05-20  6:05         ` Rical Jasan
2017-05-19  9:34     ` [PATCH v4 3/5] manual: Convert errno @comments to new @errno macro Rical Jasan
2017-05-19 21:03       ` Zack Weinberg
2017-05-20  6:05         ` Rical Jasan
2017-05-19  9:34     ` [PATCH v4 1/5] manual: Provide one-off standards conversion script Rical Jasan
2017-05-19  9:34     ` [PATCH v4 5/5] manual: Replace summary.awk with summary.pl Rical Jasan
2017-05-19  9:36     ` [PATCH v4 4/5] manual: Convert header and standards @comments to @standards Rical Jasan
2017-05-19 21:05     ` [PATCH v4 0/5] manual: Header & Standards Cleanup Zack Weinberg
2017-05-22  9:03       ` Rical Jasan
2017-05-24 13:12         ` Rical Jasan
2017-05-24 13:29           ` Zack Weinberg
2017-05-26  5:01     ` [PATCH v5 0/3] " Rical Jasan
2017-05-26  5:01       ` [PATCH v5 3/3] manual: Replace summary.awk with summary.pl Rical Jasan
2017-05-26  5:01       ` [PATCH v5 2/3] manual: Convert header and standards @comments to @standards Rical Jasan
2017-05-26  5:01       ` [PATCH v5 1/3] manual: Create empty placeholder macros for @standards Rical Jasan
2017-05-26  5:01       ` [PATCH v5 0/3] manual: Header & Standards Cleanup [conversion script] Rical Jasan
2017-05-31  9:23       ` [PATCH v5 0/3] manual: Header & Standards Cleanup Rical Jasan
2017-06-08 11:46         ` [PING] " Rical Jasan
2017-06-08 13:41           ` Zack Weinberg
2017-06-09  2:31             ` Rical Jasan
2017-06-15  8:47               ` Rical Jasan
2017-06-15  8:32           ` Rical Jasan
2017-06-15 18:01             ` Joseph Myers
2017-06-16  4:38               ` Rical Jasan

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=04419bff545d1647a0c23b72b3498c9f1b04beab.1494920105.git.ricaljasan@pacific.net \
    --to=ricaljasan@pacific.net \
    --cc=carlos@redhat.com \
    --cc=joseph@codesourcery.com \
    --cc=libc-alpha@sourceware.org \
    --cc=mtk.manpages@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).