AuroraMiddleware/glibc
1
0
Fork 0
mirror of https://sourceware.org/git/glibc.git synced 2024-09-20 00:19:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Manual typos: The Basic Program/System Interface

Browse Source 
2016-05-06  Rical Jasan  <ricaljasan@pacific.net>

	* manual/argp.texi: Fix typos in the manual.
	* manual/getopt.texi: Likewise.
	* manual/startup.texi: Likewise.
This commit is contained in:
Rical Jasan 2016-10-06 12:19:25 +05:30 committed by Siddhesh Poyarekar
parent 16c7d1ec26
commit 954cbda0fa
4 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,5 +1,9 @@
2016-10-06 Rical Jasan <ricaljasan@pacific.net> 2016-10-06 Rical Jasan <ricaljasan@pacific.net>
* manual/argp.texi: Fix typos in the manual.
* manual/getopt.texi: Likewise.
* manual/startup.texi: Likewise.
* manual/signal.texi: Fix typos in the manual. * manual/signal.texi: Fix typos in the manual.
* manual/setjmp.texi: Fix typos in the manual. * manual/setjmp.texi: Fix typos in the manual.

10
manual/argp.texi
View File

@ -347,7 +347,7 @@ be displayed in much the same manner as the options. This is known as a
If this flag is set, then the option @code{name} field is displayed If this flag is set, then the option @code{name} field is displayed
unmodified (e.g., no @samp{--} prefix is added) at the left-margin where unmodified (e.g., no @samp{--} prefix is added) at the left-margin where
a @emph{short} option would normally be displayed, and this a @emph{short} option would normally be displayed, and this
documentation string is left in it's usual place. For purposes of documentation string is left in its usual place. For purposes of
sorting, any leading whitespace and punctuation is ignored, unless the sorting, any leading whitespace and punctuation is ignored, unless the
first non-whitespace character is @samp{-}. This entry is displayed first non-whitespace character is @samp{-}. This entry is displayed
after all options, after @code{OPTION_DOC} entries with a leading after all options, after @code{OPTION_DOC} entries with a leading
@ -692,7 +692,7 @@ parser function. @xref{Argp Parsing State}.
@safety{@prelim{}@mtunsafe{@mtasurace{:argpbuf} @mtsenv{} @mtslocale{}}@asunsafe{@ascuheap{} @ascuintl{} @asucorrupt{}}@acunsafe{@acsmem{} @acucorrupt{} @aculock{}}} @safety{@prelim{}@mtunsafe{@mtasurace{:argpbuf} @mtsenv{} @mtslocale{}}@asunsafe{@ascuheap{} @ascuintl{} @asucorrupt{}}@acunsafe{@acsmem{} @acucorrupt{} @aculock{}}}
@c Just calls argp_state_help with stderr and ARGP_HELP_STD_USAGE. @c Just calls argp_state_help with stderr and ARGP_HELP_STD_USAGE.
Outputs the standard usage message for the argp parser referred to by Outputs the standard usage message for the argp parser referred to by
@var{state} to @code{@var{state}->err_stream} and terminate the program @var{state} to @code{@var{state}->err_stream} and terminates the program
with @code{exit (argp_err_exit_status)}. @xref{Argp Global Variables}. with @code{exit (argp_err_exit_status)}. @xref{Argp Global Variables}.
@end deftypefun @end deftypefun
@ -723,7 +723,7 @@ by the program name and @samp{:}, and followed by a @w{@samp{Try @dots{}
@c blank, release the buffer, call strerror_r with an automatic buffer, @c blank, release the buffer, call strerror_r with an automatic buffer,
@c print it out after colon and blank, put[w]c a line break, unlock the @c print it out after colon and blank, put[w]c a line break, unlock the
@c stream, then exit unless ARGP_NO_EXIT. @c stream, then exit unless ARGP_NO_EXIT.
Similar to the standard gnu error-reporting function @code{error}, this Similar to the standard GNU error-reporting function @code{error}, this
prints the program name and @samp{:}, the printf format string prints the program name and @samp{:}, the printf format string
@var{fmt}, and the appropriate following args. If it is non-zero, the @var{fmt}, and the appropriate following args. If it is non-zero, the
standard unix error text for @var{errnum} is printed. If @var{status} is standard unix error text for @var{errnum} is printed. If @var{status} is
@ -1010,7 +1010,7 @@ Don't exit on errors, although they may still result in error messages.
@comment argp.h @comment argp.h
@comment GNU @comment GNU
@item ARGP_LONG_ONLY @item ARGP_LONG_ONLY
Use the gnu getopt `long-only' rules for parsing arguments. This allows Use the GNU getopt `long-only' rules for parsing arguments. This allows
long-options to be recognized with only a single @samp{-} long-options to be recognized with only a single @samp{-}
(i.e., @samp{-help}). This results in a less useful interface, and its (i.e., @samp{-help}). This results in a less useful interface, and its
use is discouraged as it conflicts with the way most GNU programs work use is discouraged as it conflicts with the way most GNU programs work
@ -1213,7 +1213,7 @@ These example programs demonstrate the basic usage of argp.
@subsubsection A Minimal Program Using Argp @subsubsection A Minimal Program Using Argp
This is perhaps the smallest program possible that uses argp. It won't This is perhaps the smallest program possible that uses argp. It won't
do much except give an error messages and exit when there are any do much except give an error message and exit when there are any
arguments, and prints a rather pointless message for @samp{--help}. arguments, and prints a rather pointless message for @samp{--help}.
@smallexample @smallexample

10
manual/getopt.texi
View File

@ -110,7 +110,7 @@ is treated specially. It permits arguments that are not options to be
returned as if they were associated with option character @samp{\1}. returned as if they were associated with option character @samp{\1}.
@item @item
POSIX demands the following behavior: The first non-option stops option POSIX demands the following behavior: the first non-option stops option
processing. This mode is selected by either setting the environment processing. This mode is selected by either setting the environment
variable @code{POSIXLY_CORRECT} or beginning the @var{options} argument variable @code{POSIXLY_CORRECT} or beginning the @var{options} argument
string with a plus sign (@samp{+}). string with a plus sign (@samp{+}).
@ -256,7 +256,7 @@ options to accept (see above).
When @code{getopt_long} encounters a short option, it does the same When @code{getopt_long} encounters a short option, it does the same
thing that @code{getopt} would do: it returns the character code for the thing that @code{getopt} would do: it returns the character code for the
option, and stores the options argument (if it has one) in @code{optarg}. option, and stores the option's argument (if it has one) in @code{optarg}.
When @code{getopt_long} encounters a long option, it takes actions based When @code{getopt_long} encounters a long option, it takes actions based
on the @code{flag} and @code{val} fields of the definition of that on the @code{flag} and @code{val} fields of the definition of that
@ -293,8 +293,8 @@ When @code{getopt_long} has no more options to handle, it returns
@var{argv} of the next remaining argument. @var{argv} of the next remaining argument.
@end deftypefun @end deftypefun
Since long option names were used before the @code{getopt_long} Since long option names were used before @code{getopt_long}
options was invented there are program interfaces which require programs was invented there are program interfaces which require programs
to recognize options like @w{@samp{-option value}} instead of to recognize options like @w{@samp{-option value}} instead of
@w{@samp{--option value}}. To enable these programs to use the GNU @w{@samp{--option value}}. To enable these programs to use the GNU
getopt functionality there is one more function available. getopt functionality there is one more function available.
@ -306,7 +306,7 @@ getopt functionality there is one more function available.
@c Same issues as getopt. @c Same issues as getopt.
The @code{getopt_long_only} function is equivalent to the The @code{getopt_long_only} function is equivalent to the
@code{getopt_long} function but it allows to specify the user of the @code{getopt_long} function but it allows the user of the
application to pass long options with only @samp{-} instead of application to pass long options with only @samp{-} instead of
@samp{--}. The @samp{--} prefix is still recognized but instead of @samp{--}. The @samp{--} prefix is still recognized but instead of
looking through the short options if a @samp{-} is seen it is first looking through the short options if a @samp{-} is seen it is first

8
manual/startup.texi
View File

@ -18,7 +18,7 @@ one program.
Note that we are using a specific definition of ``program'' for the Note that we are using a specific definition of ``program'' for the
purposes of this manual, which corresponds to a common definition in the purposes of this manual, which corresponds to a common definition in the
context of Unix system. In popular usage, ``program'' enjoys a much context of Unix systems. In popular usage, ``program'' enjoys a much
broader definition; it can refer for example to a system's kernel, an broader definition; it can refer for example to a system's kernel, an
editor macro, a complex package of software, or a discrete section of editor macro, a complex package of software, or a discrete section of
code executing within a process. code executing within a process.
@ -228,9 +228,9 @@ available.
@c strncmp dup ok @c strncmp dup ok
The @var{optionp} parameter must be a pointer to a variable containing The @var{optionp} parameter must be a pointer to a variable containing
the address of the string to process. When the function returns the the address of the string to process. When the function returns, the
reference is updated to point to the next suboption or to the reference is updated to point to the next suboption or to the
terminating @samp{\0} character if there is no more suboption available. terminating @samp{\0} character if there are no more suboptions available.
The @var{tokens} parameter references an array of strings containing the The @var{tokens} parameter references an array of strings containing the
known suboptions. All strings must be @samp{\0} terminated and to mark known suboptions. All strings must be @samp{\0} terminated and to mark
@ -441,7 +441,7 @@ environment. If the environment contains an entry with the key
equivalent to a call to @code{putenv} when the @var{value} part of the equivalent to a call to @code{putenv} when the @var{value} part of the
string is empty. string is empty.
The function return @code{-1} if @var{name} is a null pointer, points to The function returns @code{-1} if @var{name} is a null pointer, points to
an empty string, or points to a string containing a @code{=} character. an empty string, or points to a string containing a @code{=} character.
It returns @code{0} if the call succeeded. It returns @code{0} if the call succeeded.