+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>
+
+ * configure.in: Don't use in-tree texinfo, because libiberty must
+ be built before it. Check for makeinfo version 4 or higher.
+ * functions.texi: Regenerate.
+
2001-09-20 DJ Delorie <dj@redhat.com>
Phil Edwards <pedwards@disaster.jaj.com>
AC_SUBST(MAINT)dnl
AC_SUBST(NOTMAINT)dnl
-# Do we have a single-tree copy of texinfo?
-if test -f $srcdir/../texinfo/Makefile.in; then
- MAKEINFO='$(objdir)/../texinfo/makeinfo/makeinfo'
- AC_MSG_RESULT([Using makeinfo from the unified source tree.])
-else
- AC_CHECK_PROG(MAKEINFO, makeinfo, makeinfo, )
-fi
-if test x"$MAKEINFO" = x""; then
- BUILD_INFO=
-else
- BUILD_INFO=info
-fi
+# Do we have a single-tree copy of texinfo? Even if we do, we can't
+# rely on it - libiberty is built before texinfo.
+AC_CHECK_PROG(MAKEINFO, makeinfo, makeinfo, )
+BUILD_INFO=info
+case x"`$MAKEINFO --version | grep 'GNU texinfo'`" in
+ x*\ [[1-3]].* )
+ MAKEINFO="@echo $MAKEINFO is too old, 4.0 or newer required ;true"
+ BUILD_INFO=
+ AC_MSG_WARN([
+*** Makeinfo is too old. Info documentation will not be built.])
+ ;;
+esac
+AC_SUBST(MAKEINFO)
AC_SUBST(BUILD_INFO)
AC_CHECK_PROG(PERL, perl, perl, )
-@node Library Copying,,,Licenses
+@node Library Copying
@appendixsec GNU LESSER GENERAL PUBLIC LICENSE
@cindex LGPL, Lesser General Public License
comparison function. This routine should take two arguments pointing to
the @var{key} and to an array member, in that order, and should return an
integer less than, equal to, or greater than zero if the @var{key} object
-is respecitively less than, matching, or greater than the array member.
+is respectively less than, matching, or greater than the array member.
@end deftypefn
@c bzero.c:6
@deftypefn Supplemental void bzero (char *@var{mem}, int @var{count})
-Zeros @var{count} bytes starting at @var{mem}. Use if this function
+Zeros @var{count} bytes starting at @var{mem}. Use of this function
is deprecated in favor of @code{memset}.
@end deftypefn
@c index.c:5
@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
deprecated in new programs in favor of @code{strchr}.
@c rindex.c:5
@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
deprecated in new programs in favor of @code{strrchr}.
@c strchr.c:6
@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
null character, the results are undefined.
If the supplied error number is within the valid range of indices for
symbolic names, but no name is available for the particular error
-number, then returns the string @samp{"Error NUM"}, where NUM is the
-error number.
+number, then returns the string @samp{"Error @var{num}"}, where @var{num}
+is the error number.
If the supplied error number is not within the range of valid
indices, then returns NULL.
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
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
-error number, then returns the string @samp{"Error NUM"}, where NUM is
-the error number.
+error number, then returns the string @samp{"Error @var{num}"}, where
+@var{num} is the error number.
If the supplied error number is not a valid index into
@code{sys_errlist}, returns NULL.
@c strrchr.c:6
@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
null character, the results are undefined.
@deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub})
This function searches for the substring @var{sub} in the string
-@var{string}, not including the terminating NUL characters. A pointer
-to the first occurance of @var{sub} is returned, or NULL if the
+@var{string}, not including the terminating null characters. A pointer
+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
length, the function returns @var{string}.
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.
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.
@end deftypefn
@deftypefun int xatexit (void (*@var{fn}) (void))
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
@code{xexit} to terminate your program.
@end deftypefun
-@c xmalloc.c:37
+@c xmalloc.c:38
@deftypefn Replacement void* xcalloc (size_t, size_t)
Allocate memory without fail, and set it to zero. This routine functions
@deftypefn Replacement void xexit (int @var{code})
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.
@end deftypefn
@deftypefn Replacement void* xmalloc (size_t)
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
a program to contain @code{#define malloc xmalloc} in its source.
@end deftypefn
-@c xmalloc.c:52
+@c xmalloc.c:53
@deftypefn Replacement void xmalloc_failed (size_t)
This function is not meant to be called by client code, and is listed
@end deftypefn
-@c xmalloc.c:45
+@c xmalloc.c:46
@deftypefn Replacement void xmalloc_set_program_name (const char *@var{name})
You can use this to set the name of the program used by
@end deftypefn
-@c xmalloc.c:31
+@c xmalloc.c:32
@deftypefn Replacement void* xrealloc (void*, size_t)
Reallocate memory without fail. This routine functions like @code{realloc},
but will behave the same as @code{xmalloc} if memory cannot be found.
@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
deprecated in new programs in favor of @code{strchr}.
@syncodeindex fn 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
@code{libiberty}
* Index:: Index of functions and categories.
@end menu
-@node Using,Overview,Top,Top
+@node Using
@chapter Using
@cindex using libiberty
@cindex libiberty usage
Passing @option{--enable-install-libiberty} to the @command{configure}
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
manner as @option{--prefix}.
add @option{-liberty} to your link command invocation.
-@node Overview,Functions,Using,Top
+@node Overview
@chapter Overview
Functions contained in @libib{} can be divided into three general categories.
or safety wrappers around existing code.
@end menu
-@node Supplemental Functions,Replacement Functions,,Overview
+@node Supplemental Functions
@section Supplemental Functions
@cindex supplemental functions
@cindex functions, supplemental
Many such functions are provided in @libib{}. They are quickly
listed here with little description, as systems which lack them
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
available in the source file. Generally, the function can simply
be declared as @code{extern}.
-@node Replacement Functions,Extensions,Supplemental Functions,Overview
+@node Replacement Functions
@section Replacement Functions
@cindex replacement functions
@cindex functions, replacement
@subsection 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
are called and their results checked before the results are passed back
to client code. If the standard functions fail, these wrappers will
@c signal stuff
-@node Extensions,,Replacement Functions,Overview
+@node Extensions
@section Extensions
@cindex extensions
@cindex functions, extension
* Obstacks:: Stacks of arbitrary objects.
@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 script of Phil's. Hope it's accurate.
@include obstacks.texi
+@node Functions
+@chapter Function, Variable, and Macro Listing.
+@include functions.texi
-@node Licenses,Index,Obstacks,Top
+@node Licenses
@appendix Licenses
@menu
-* Library Copying:: The GNU Libary General Public License
+* Library Copying:: The GNU Library General Public License
* BSD:: Regents of the University of California
@end menu
@c This takes care of Library Copying. It is the copying-lib.texi from the
-@c GNU website, with its @node line altered to make makeinfo shut up.
+@c GNU web site, with its @node line altered to make makeinfo shut up.
@include copying-lib.texi
@page
-@node BSD,,,Licenses
+@node BSD
@appendixsec BSD
Copyright @copyright{} 1990 Regents of the University of California.
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
-@node Index,,Licenses,Top
+@node Index
@unnumbered Index
@printindex cp
@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
deprecated in new programs in favor of @code{strrchr}.
@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
null character, the results are undefined.
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
-error number, then returns the string @samp{"Error NUM"}, where NUM is
-the error number.
+error number, then returns the string @samp{"Error @var{num}"}, where
+@var{num} is the error number.
If the supplied error number is not a valid index into
@code{sys_errlist}, returns NULL.
If the supplied error number is within the valid range of indices for
symbolic names, but no name is available for the particular error
-number, then returns the string @samp{"Error NUM"}, where NUM is the
-error number.
+number, then returns the string @samp{"Error @var{num}"}, where @var{num}
+is the error number.
If the supplied error number is not within the range of valid
indices, then returns NULL.
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
@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
null character, the results are undefined.
@deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub})
This function searches for the substring @var{sub} in the string
-@var{string}, not including the terminating NUL characters. A pointer
-to the first occurance of @var{sub} is returned, or NULL if the
+@var{string}, not including the terminating null characters. A pointer
+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
length, the function returns @var{string}.
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.
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.
@end deftypefn
@deftypefun int xatexit (void (*@var{fn}) (void))
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
@code{xexit} to terminate your program.
@deftypefn Replacement void xexit (int @var{code})
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.
@end deftypefn
@deftypefn Replacement void* xmalloc (size_t)
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
a program to contain @code{#define malloc xmalloc} in its source.
projects / binutils-gdb.git / commitdiff