git
/
gcc
mirror of git://gcc.gnu.org/git/gcc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

libiberty.texi: (Top level): Add syncodeindex pg. 

* libiberty.texi: (Top level): Add syncodeindex pg.  Add
@dircategory and @direntry directives.  Add @finalout.
(many nodes): Lose the next,prev,up pointers on the @nide line.
(Using, Supplemental Functions, Replacement Functions): Fix
markup.
(Functions): Move around, to allow makeinfo to build the manual
without next,prev,up pointers in thye node lines.
(Licenses): Fix typos.

* index.c, rindex.c, strchr.c, strerror.c, strrchr.c, strstr.c,
strtol.c, xatexit.c, xexit.c, xmalloc.c: Fix spelling and markup.
* functions.texi: Regenerate.

* copying-lib.texi: Lose the next,prev,up pointers on the @node
line.

From-SVN: r45847
This commit is contained in:
Eli Zaretskii 2001-09-27 21:55:37 +02:00 committed by DJ Delorie
parent ae9092da96
commit e922f9785c
14 changed files with 81 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
libiberty/ChangeLog
View File

@ -1,3 +1,21 @@
2001-09-27 Eli Zaretskii <eliz@is.elta.co.il>
* libiberty.texi: (Top level): Add syncodeindex pg. Add
@dircategory and @direntry directives. Add @finalout.
(many nodes): Lose the next,prev,up pointers on the @nide line.
(Using, Supplemental Functions, Replacement Functions): Fix
markup.
(Functions): Move around, to allow makeinfo to build the manual
without next,prev,up pointers in thye node lines.
(Licenses): Fix typos.
* index.c, rindex.c, strchr.c, strerror.c, strrchr.c, strstr.c,
strtol.c, xatexit.c, xexit.c, xmalloc.c: Fix spelling and markup.
* functions.texi: Regenerate.
* copying-lib.texi: Lose the next,prev,up pointers on the @node
line.
2001-09-27 DJ Delorie <dj@redhat.com> 2001-09-27 DJ Delorie <dj@redhat.com>
* configure.in: Don't use in-tree texinfo, because libiberty must * configure.in: Don't use in-tree texinfo, because libiberty must

2
libiberty/copying-lib.texi
View File

@ -1,4 +1,4 @@
@node Library Copying,,,Licenses @node Library Copying
@appendixsec GNU LESSER GENERAL PUBLIC LICENSE @appendixsec GNU LESSER GENERAL PUBLIC LICENSE
@cindex LGPL, Lesser General Public License @cindex LGPL, Lesser General Public License

39
libiberty/functions.texi
View File

@ -147,7 +147,7 @@ between calls to @code{getpwd}.
@c index.c:5 @c index.c:5
@deftypefn Supplemental char* index (char *@var{s}, int @var{c}) @deftypefn Supplemental char* index (char *@var{s}, int @var{c})
Returns a pointer to the first occurance of the character @var{c} in Returns a pointer to the first occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. The use of @code{index} is the string @var{s}, or NULL if not found. The use of @code{index} is
deprecated in new programs in favor of @code{strchr}. deprecated in new programs in favor of @code{strchr}.
@ -222,7 +222,7 @@ exists, it is removed.
@c rindex.c:5 @c rindex.c:5
@deftypefn Supplemental char* rindex (const char *@var{s}, int @var{c}) @deftypefn Supplemental char* rindex (const char *@var{s}, int @var{c})
Returns a pointer to the last occurance of the character @var{c} in Returns a pointer to the last occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. The use of @code{rindex} is the string @var{s}, or NULL if not found. The use of @code{rindex} is
deprecated in new programs in favor of @code{strrchr}. deprecated in new programs in favor of @code{strrchr}.
@ -259,7 +259,7 @@ A case-insensitive @code{strcmp}.
@c strchr.c:6 @c strchr.c:6
@deftypefn Supplemental char* strchr (const char *@var{s}, int @var{c}) @deftypefn Supplemental char* strchr (const char *@var{s}, int @var{c})
Returns a pointer to the first occurance of the character @var{c} in Returns a pointer to the first occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. If @var{c} is itself the the string @var{s}, or NULL if not found. If @var{c} is itself the
null character, the results are undefined. null character, the results are undefined.
@ -282,14 +282,14 @@ symbolic name of that error number, as found in @file{errno.h}.
If the supplied error number is within the valid range of indices for If the supplied error number is within the valid range of indices for
symbolic names, but no name is available for the particular error symbolic names, but no name is available for the particular error
number, then returns the string @samp{"Error NUM"}, where NUM is the number, then returns the string @samp{"Error @var{num}"}, where @var{num}
error number. is the error number.
If the supplied error number is not within the range of valid If the supplied error number is not within the range of valid
indices, then returns NULL. indices, then returns NULL.
The contents of the location pointed to are only guaranteed to be The contents of the location pointed to are only guaranteed to be
valid until the next call to strerrno. valid until the next call to @code{strerrno}.
@end deftypefn @end deftypefn
@ -303,8 +303,8 @@ strings will be the same as the ones used by @code{perror}.
If the supplied error number is within the valid range of indices for If the supplied error number is within the valid range of indices for
the @code{sys_errlist}, but no message is available for the particular the @code{sys_errlist}, but no message is available for the particular
error number, then returns the string @samp{"Error NUM"}, where NUM is error number, then returns the string @samp{"Error @var{num}"}, where
the error number. @var{num} is the error number.
If the supplied error number is not a valid index into If the supplied error number is not a valid index into
@code{sys_errlist}, returns NULL. @code{sys_errlist}, returns NULL.
@ -332,7 +332,7 @@ Compares the first @var{n} bytes of two strings, returning a value as
@c strrchr.c:6 @c strrchr.c:6
@deftypefn Supplemental char* strrchr (const char *@var{s}, int @var{c}) @deftypefn Supplemental char* strrchr (const char *@var{s}, int @var{c})
Returns a pointer to the last occurance of the character @var{c} in Returns a pointer to the last occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. If @var{c} is itself the the string @var{s}, or NULL if not found. If @var{c} is itself the
null character, the results are undefined. null character, the results are undefined.
@ -342,8 +342,8 @@ null character, the results are undefined.
@deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub}) @deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub})
This function searches for the substring @var{sub} in the string This function searches for the substring @var{sub} in the string
@var{string}, not including the terminating NUL characters. A pointer @var{string}, not including the terminating null characters. A pointer
to the first occurance of @var{sub} is returned, or NULL if the to the first occurrence of @var{sub} is returned, or NULL if the
substring is absent. If @var{sub} points to a string with zero substring is absent. If @var{sub} points to a string with zero
length, the function returns @var{string}. length, the function returns @var{string}.
@ -378,7 +378,7 @@ between 2 and 36 inclusive, or be the special value 0. If @var{base}
is 0, @code{strtol} will look for the prefixes @code{0} and @code{0x} is 0, @code{strtol} will look for the prefixes @code{0} and @code{0x}
to indicate bases 8 and 16, respectively, else default to base 10. to indicate bases 8 and 16, respectively, else default to base 10.
When the base is 16 (either explicitly or implicitly), a prefix of When the base is 16 (either explicitly or implicitly), a prefix of
@code{0x} is allowed. The handling of endptr is as that of @code{0x} is allowed. The handling of @var{endptr} is as that of
@code{strtod} above. @code{strtod} above.
@end deftypefn @end deftypefn
@ -428,13 +428,13 @@ does the return value. The third argument is unused in @libib{}.
@deftypefun int xatexit (void (*@var{fn}) (void)) @deftypefun int xatexit (void (*@var{fn}) (void))
Behaves as the standard @code{atexit} function, but with no limit on Behaves as the standard @code{atexit} function, but with no limit on
the number of registered funtions. Returns 0 on success, or -1 on the number of registered functions. Returns 0 on success, or -1 on
failure. If you use @code{xatexit} to register functions, you must use failure. If you use @code{xatexit} to register functions, you must use
@code{xexit} to terminate your program. @code{xexit} to terminate your program.
@end deftypefun @end deftypefun
@c xmalloc.c:37 @c xmalloc.c:38
@deftypefn Replacement void* xcalloc (size_t, size_t) @deftypefn Replacement void* xcalloc (size_t, size_t)
Allocate memory without fail, and set it to zero. This routine functions Allocate memory without fail, and set it to zero. This routine functions
@ -447,7 +447,7 @@ cannot be found.
@deftypefn Replacement void xexit (int @var{code}) @deftypefn Replacement void xexit (int @var{code})
Terminates the program. If any functions have been registered with Terminates the program. If any functions have been registered with
the @code{xatexit} rpelacement function, they will be called first. the @code{xatexit} replacement function, they will be called first.
Termination is handled via the system's normal @code{exit} call. Termination is handled via the system's normal @code{exit} call.
@end deftypefn @end deftypefn
@ -456,13 +456,14 @@ Termination is handled via the system's normal @code{exit} call.
@deftypefn Replacement void* xmalloc (size_t) @deftypefn Replacement void* xmalloc (size_t)
Allocate memory without fail. If @code{malloc} fails, this will print Allocate memory without fail. If @code{malloc} fails, this will print
a message to stderr (using the name set by @code{xmalloc_set_program_name}, a message to @code{stderr} (using the name set by
@code{xmalloc_set_program_name},
if any) and then call @code{xexit}. Note that it is therefore safe for if any) and then call @code{xexit}. Note that it is therefore safe for
a program to contain @code{#define malloc xmalloc} in its source. a program to contain @code{#define malloc xmalloc} in its source.
@end deftypefn @end deftypefn
@c xmalloc.c:52 @c xmalloc.c:53
@deftypefn Replacement void xmalloc_failed (size_t) @deftypefn Replacement void xmalloc_failed (size_t)
This function is not meant to be called by client code, and is listed This function is not meant to be called by client code, and is listed
@ -471,7 +472,7 @@ function will be called to print an error message and terminate execution.
@end deftypefn @end deftypefn
@c xmalloc.c:45 @c xmalloc.c:46
@deftypefn Replacement void xmalloc_set_program_name (const char *@var{name}) @deftypefn Replacement void xmalloc_set_program_name (const char *@var{name})
You can use this to set the name of the program used by You can use this to set the name of the program used by
@ -489,7 +490,7 @@ allocated, the remaining memory is zeroed.
@end deftypefn @end deftypefn
@c xmalloc.c:31 @c xmalloc.c:32
@deftypefn Replacement void* xrealloc (void*, size_t) @deftypefn Replacement void* xrealloc (void*, size_t)
Reallocate memory without fail. This routine functions like @code{realloc}, Reallocate memory without fail. This routine functions like @code{realloc},
but will behave the same as @code{xmalloc} if memory cannot be found. but will behave the same as @code{xmalloc} if memory cannot be found.

2
libiberty/index.c
View File

@ -4,7 +4,7 @@
@deftypefn Supplemental char* index (char *@var{s}, int @var{c}) @deftypefn Supplemental char* index (char *@var{s}, int @var{c})
Returns a pointer to the first occurance of the character @var{c} in Returns a pointer to the first occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. The use of @code{index} is the string @var{s}, or NULL if not found. The use of @code{index} is
deprecated in new programs in favor of @code{strchr}. deprecated in new programs in favor of @code{strchr}.

42
libiberty/libiberty.texi
View File

@ -6,6 +6,16 @@
@syncodeindex fn cp @syncodeindex fn cp
@syncodeindex vr cp @syncodeindex vr cp
@syncodeindex pg cp
@finalout
@c %**end of header
@dircategory GNU libraries
@direntry
* Libiberty: (libiberty). Library of utility functions which
are missing or broken on some systems.
@end direntry
@macro libib @macro libib
@code{libiberty} @code{libiberty}
@ -85,7 +95,7 @@ This edition accompanies GCC 3, September 2001.
* Index:: Index of functions and categories. * Index:: Index of functions and categories.
@end menu @end menu
@node Using,Overview,Top,Top @node Using
@chapter Using @chapter Using
@cindex using libiberty @cindex using libiberty
@cindex libiberty usage @cindex libiberty usage
@ -104,7 +114,7 @@ elsewhere on the system.
Passing @option{--enable-install-libiberty} to the @command{configure} Passing @option{--enable-install-libiberty} to the @command{configure}
script when building @libib{} causes the header files and archive library script when building @libib{} causes the header files and archive library
to be installed when @samp{make install} is run. This option also takes to be installed when @kbd{make install} is run. This option also takes
an (optional) argument to specify the installation location, in the same an (optional) argument to specify the installation location, in the same
manner as @option{--prefix}. manner as @option{--prefix}.
@ -121,7 +131,7 @@ necessary in the function descriptions.) At link time, you will need to
add @option{-liberty} to your link command invocation. add @option{-liberty} to your link command invocation.
@node Overview,Functions,Using,Top @node Overview
@chapter Overview @chapter Overview
Functions contained in @libib{} can be divided into three general categories. Functions contained in @libib{} can be divided into three general categories.
@ -138,7 +148,7 @@ Functions contained in @libib{} can be divided into three general categories.
or safety wrappers around existing code. or safety wrappers around existing code.
@end menu @end menu
@node Supplemental Functions,Replacement Functions,,Overview @node Supplemental Functions
@section Supplemental Functions @section Supplemental Functions
@cindex supplemental functions @cindex supplemental functions
@cindex functions, supplemental @cindex functions, supplemental
@ -159,14 +169,14 @@ family of systems.
Many such functions are provided in @libib{}. They are quickly Many such functions are provided in @libib{}. They are quickly
listed here with little description, as systems which lack them listed here with little description, as systems which lack them
become less and less common. Each function @var{foo} is implemented become less and less common. Each function @var{foo} is implemented
in @file{foo.c} but not declared in any @libib{} header file; more in @file{@var{foo}.c} but not declared in any @libib{} header file; more
comments and caveats for each function's implementation are often comments and caveats for each function's implementation are often
available in the source file. Generally, the function can simply available in the source file. Generally, the function can simply
be declared as @code{extern}. be declared as @code{extern}.
@node Replacement Functions,Extensions,Supplemental Functions,Overview @node Replacement Functions
@section Replacement Functions @section Replacement Functions
@cindex replacement functions @cindex replacement functions
@cindex functions, replacement @cindex functions, replacement
@ -196,7 +206,7 @@ functions may call one another.
@subsection Memory Allocation @subsection Memory Allocation
@cindex memory allocation @cindex memory allocation
The functions beginning with the letter `x' are wrappers around The functions beginning with the letter @samp{x} are wrappers around
standard functions; the functions provided by the system environment standard functions; the functions provided by the system environment
are called and their results checked before the results are passed back are called and their results checked before the results are passed back
to client code. If the standard functions fail, these wrappers will to client code. If the standard functions fail, these wrappers will
@ -223,7 +233,7 @@ contains a good deal of documentation for these functions.
@c signal stuff @c signal stuff
@node Extensions,,Replacement Functions,Overview @node Extensions
@section Extensions @section Extensions
@cindex extensions @cindex extensions
@cindex functions, extension @cindex functions, extension
@ -238,22 +248,20 @@ central location from which to use, maintain, and distribute them.
* Obstacks:: Stacks of arbitrary objects. * Obstacks:: Stacks of arbitrary objects.
@end menu @end menu
@node Functions,Obstacks,Overview,Top
@chapter Function, Variable, and Macro Listing.
@include functions.texi
@c This is generated from the glibc manual using a make-obstacks-texi.sh @c This is generated from the glibc manual using a make-obstacks-texi.sh
@c script of Phil's. Hope it's accurate. @c script of Phil's. Hope it's accurate.
@include obstacks.texi @include obstacks.texi
@node Functions
@chapter Function, Variable, and Macro Listing.
@include functions.texi
@node Licenses,Index,Obstacks,Top @node Licenses
@appendix Licenses @appendix Licenses
@menu @menu
* Library Copying:: The GNU Libary General Public License * Library Copying:: The GNU Library General Public License
* BSD:: Regents of the University of California * BSD:: Regents of the University of California
@end menu @end menu
@ -263,7 +271,7 @@ central location from which to use, maintain, and distribute them.
@include copying-lib.texi @include copying-lib.texi
@page @page
@node BSD,,,Licenses @node BSD
@appendixsec BSD @appendixsec BSD
Copyright @copyright{} 1990 Regents of the University of California. Copyright @copyright{} 1990 Regents of the University of California.
@ -306,7 +314,7 @@ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE. SUCH DAMAGE.
@node Index,,Licenses,Top @node Index
@unnumbered Index @unnumbered Index
@printindex cp @printindex cp

2
libiberty/rindex.c
View File

@ -4,7 +4,7 @@
@deftypefn Supplemental char* rindex (const char *@var{s}, int @var{c}) @deftypefn Supplemental char* rindex (const char *@var{s}, int @var{c})
Returns a pointer to the last occurance of the character @var{c} in Returns a pointer to the last occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. The use of @code{rindex} is the string @var{s}, or NULL if not found. The use of @code{rindex} is
deprecated in new programs in favor of @code{strrchr}. deprecated in new programs in favor of @code{strrchr}.

2
libiberty/strchr.c
View File

@ -5,7 +5,7 @@
@deftypefn Supplemental char* strchr (const char *@var{s}, int @var{c}) @deftypefn Supplemental char* strchr (const char *@var{s}, int @var{c})
Returns a pointer to the first occurance of the character @var{c} in Returns a pointer to the first occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. If @var{c} is itself the the string @var{s}, or NULL if not found. If @var{c} is itself the
null character, the results are undefined. null character, the results are undefined.

10
libiberty/strerror.c
View File

@ -608,8 +608,8 @@ strings will be the same as the ones used by @code{perror}.
If the supplied error number is within the valid range of indices for If the supplied error number is within the valid range of indices for
the @code{sys_errlist}, but no message is available for the particular the @code{sys_errlist}, but no message is available for the particular
error number, then returns the string @samp{"Error NUM"}, where NUM is error number, then returns the string @samp{"Error @var{num}"}, where
the error number. @var{num} is the error number.
If the supplied error number is not a valid index into If the supplied error number is not a valid index into
@code{sys_errlist}, returns NULL. @code{sys_errlist}, returns NULL.
@ -675,14 +675,14 @@ symbolic name of that error number, as found in @file{errno.h}.
If the supplied error number is within the valid range of indices for If the supplied error number is within the valid range of indices for
symbolic names, but no name is available for the particular error symbolic names, but no name is available for the particular error
number, then returns the string @samp{"Error NUM"}, where NUM is the number, then returns the string @samp{"Error @var{num}"}, where @var{num}
error number. is the error number.
If the supplied error number is not within the range of valid If the supplied error number is not within the range of valid
indices, then returns NULL. indices, then returns NULL.
The contents of the location pointed to are only guaranteed to be The contents of the location pointed to are only guaranteed to be
valid until the next call to strerrno. valid until the next call to @code{strerrno}.
@end deftypefn @end deftypefn

2
libiberty/strrchr.c
View File

@ -5,7 +5,7 @@
@deftypefn Supplemental char* strrchr (const char *@var{s}, int @var{c}) @deftypefn Supplemental char* strrchr (const char *@var{s}, int @var{c})
Returns a pointer to the last occurance of the character @var{c} in Returns a pointer to the last occurrence of the character @var{c} in
the string @var{s}, or NULL if not found. If @var{c} is itself the the string @var{s}, or NULL if not found. If @var{c} is itself the
null character, the results are undefined. null character, the results are undefined.

4
libiberty/strstr.c
View File

@ -6,8 +6,8 @@
@deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub}) @deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub})
This function searches for the substring @var{sub} in the string This function searches for the substring @var{sub} in the string
@var{string}, not including the terminating NUL characters. A pointer @var{string}, not including the terminating null characters. A pointer
to the first occurance of @var{sub} is returned, or NULL if the to the first occurrence of @var{sub} is returned, or NULL if the
substring is absent. If @var{sub} points to a string with zero substring is absent. If @var{sub} points to a string with zero
length, the function returns @var{string}. length, the function returns @var{string}.

2
libiberty/strtol.c
View File

@ -38,7 +38,7 @@ between 2 and 36 inclusive, or be the special value 0. If @var{base}
is 0, @code{strtol} will look for the prefixes @code{0} and @code{0x} is 0, @code{strtol} will look for the prefixes @code{0} and @code{0x}
to indicate bases 8 and 16, respectively, else default to base 10. to indicate bases 8 and 16, respectively, else default to base 10.
When the base is 16 (either explicitly or implicitly), a prefix of When the base is 16 (either explicitly or implicitly), a prefix of
@code{0x} is allowed. The handling of endptr is as that of @code{0x} is allowed. The handling of @var{endptr} is as that of
@code{strtod} above. @code{strtod} above.
@end deftypefn @end deftypefn

2
libiberty/xatexit.c
View File

@ -11,7 +11,7 @@
@deftypefun int xatexit (void (*@var{fn}) (void)) @deftypefun int xatexit (void (*@var{fn}) (void))
Behaves as the standard @code{atexit} function, but with no limit on Behaves as the standard @code{atexit} function, but with no limit on
the number of registered funtions. Returns 0 on success, or -1 on the number of registered functions. Returns 0 on success, or -1 on
failure. If you use @code{xatexit} to register functions, you must use failure. If you use @code{xatexit} to register functions, you must use
@code{xexit} to terminate your program. @code{xexit} to terminate your program.

2
libiberty/xexit.c
View File

@ -22,7 +22,7 @@ Boston, MA 02111-1307, USA. */
@deftypefn Replacement void xexit (int @var{code}) @deftypefn Replacement void xexit (int @var{code})
Terminates the program. If any functions have been registered with Terminates the program. If any functions have been registered with
the @code{xatexit} rpelacement function, they will be called first. the @code{xatexit} replacement function, they will be called first.
Termination is handled via the system's normal @code{exit} call. Termination is handled via the system's normal @code{exit} call.
@end deftypefn @end deftypefn

3
libiberty/xmalloc.c
View File

@ -22,7 +22,8 @@ Boston, MA 02111-1307, USA. */
@deftypefn Replacement void* xmalloc (size_t) @deftypefn Replacement void* xmalloc (size_t)
Allocate memory without fail. If @code{malloc} fails, this will print Allocate memory without fail. If @code{malloc} fails, this will print
a message to stderr (using the name set by @code{xmalloc_set_program_name}, a message to @code{stderr} (using the name set by
@code{xmalloc_set_program_name},
if any) and then call @code{xexit}. Note that it is therefore safe for if any) and then call @code{xexit}. Note that it is therefore safe for
a program to contain @code{#define malloc xmalloc} in its source. a program to contain @code{#define malloc xmalloc} in its source.