AuroraMiddleware/glibc
1
0
Fork 0
mirror of https://sourceware.org/git/glibc.git synced 2024-11-22 04:50:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

manual: Convert @tables of annotated @items to @vtables.

Browse Source 
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.
This commit is contained in:
Rical Jasan 2017-05-15 23:41:25 -07:00
parent f227c3e0a6
commit a449fc68f6
6 changed files with 41 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
ChangeLog
View File

@ -1,3 +1,12 @@
2017-05-18 Rical Jasan <ricaljasan@pacific.net>
* 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.
2017-05-18 Rical Jasan <ricaljasan@pacific.net>
* manual/crypt.texi: Move a comment out of an @*x list.

20
manual/conf.texi
View File

@ -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

8
manual/lang.texi
View File

@ -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

28
manual/pattern.texi
View File

@ -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

4
manual/resource.texi
View File

@ -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.

4
manual/socket.texi
View File

@ -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