From: DJ Delorie Date: Thu, 27 Sep 2001 20:27:58 +0000 (+0000) Subject: merge from gcc X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=fa9f0e33b3c0510267d7a41f2f4ee72ba452c37e;p=binutils-gdb.git merge from gcc --- diff --git a/libiberty/ChangeLog b/libiberty/ChangeLog index fb3ae06cbee..d22543065da 100644 --- a/libiberty/ChangeLog +++ b/libiberty/ChangeLog @@ -1,3 +1,27 @@ +2001-09-27 Eli Zaretskii + + * 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 + + * 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 Phil Edwards diff --git a/libiberty/configure.in b/libiberty/configure.in index 0f1427a4e93..3417827b42c 100644 --- a/libiberty/configure.in +++ b/libiberty/configure.in @@ -49,18 +49,19 @@ fi 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, ) diff --git a/libiberty/copying-lib.texi b/libiberty/copying-lib.texi index 44dbd7df251..940f70e0d63 100644 --- a/libiberty/copying-lib.texi +++ b/libiberty/copying-lib.texi @@ -1,4 +1,4 @@ -@node Library Copying,,,Licenses +@node Library Copying @appendixsec GNU LESSER GENERAL PUBLIC LICENSE @cindex LGPL, Lesser General Public License diff --git a/libiberty/functions.texi b/libiberty/functions.texi index e2ea020d205..c00d047dfa8 100644 --- a/libiberty/functions.texi +++ b/libiberty/functions.texi @@ -65,14 +65,14 @@ should be sorted in ascending order according to the @var{compar} 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 @@ -147,7 +147,7 @@ between calls to @code{getpwd}. @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}. @@ -222,7 +222,7 @@ exists, it is removed. @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}. @@ -259,7 +259,7 @@ A case-insensitive @code{strcmp}. @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. @@ -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 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 @@ -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 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. @@ -332,7 +332,7 @@ Compares the first @var{n} bytes of two strings, returning a value as @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. @@ -342,8 +342,8 @@ 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}. @@ -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} 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 @@ -428,13 +428,13 @@ does the return value. The third argument is unused in @libib{}. @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 @@ -447,7 +447,7 @@ cannot be found. @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 @@ -456,13 +456,14 @@ Termination is handled via the system's normal @code{exit} call. @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 @@ -471,7 +472,7 @@ function will be called to print an error message and terminate execution. @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 @@ -489,7 +490,7 @@ allocated, the remaining memory is zeroed. @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. diff --git a/libiberty/index.c b/libiberty/index.c index 9c2ea826612..55a4acc17c2 100644 --- a/libiberty/index.c +++ b/libiberty/index.c @@ -4,7 +4,7 @@ @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}. diff --git a/libiberty/libiberty.texi b/libiberty/libiberty.texi index 9181b0f4621..a13bf2c4e17 100644 --- a/libiberty/libiberty.texi +++ b/libiberty/libiberty.texi @@ -6,6 +6,16 @@ @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} @@ -85,7 +95,7 @@ This edition accompanies GCC 3, September 2001. * Index:: Index of functions and categories. @end menu -@node Using,Overview,Top,Top +@node Using @chapter Using @cindex using libiberty @cindex libiberty usage @@ -104,7 +114,7 @@ elsewhere on the system. 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}. @@ -121,7 +131,7 @@ necessary in the function descriptions.) At link time, you will need to 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. @@ -138,7 +148,7 @@ 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 @@ -159,14 +169,14 @@ family of systems. 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 @@ -196,7 +206,7 @@ functions may call one another. @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 @@ -223,7 +233,7 @@ contains a good deal of documentation for these functions. @c signal stuff -@node Extensions,,Replacement Functions,Overview +@node Extensions @section Extensions @cindex extensions @cindex functions, extension @@ -238,32 +248,30 @@ central location from which to use, maintain, and distribute them. * 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. @@ -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 SUCH DAMAGE. -@node Index,,Licenses,Top +@node Index @unnumbered Index @printindex cp diff --git a/libiberty/rindex.c b/libiberty/rindex.c index ce397cc6029..9c25dff4dcc 100644 --- a/libiberty/rindex.c +++ b/libiberty/rindex.c @@ -4,7 +4,7 @@ @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}. diff --git a/libiberty/strchr.c b/libiberty/strchr.c index c1306dcea81..6f327f2a241 100644 --- a/libiberty/strchr.c +++ b/libiberty/strchr.c @@ -5,7 +5,7 @@ @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. diff --git a/libiberty/strerror.c b/libiberty/strerror.c index dbc29a30f34..6e42f9ec556 100644 --- a/libiberty/strerror.c +++ b/libiberty/strerror.c @@ -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 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. @@ -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 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 diff --git a/libiberty/strrchr.c b/libiberty/strrchr.c index 70418009424..9dc31f2a159 100644 --- a/libiberty/strrchr.c +++ b/libiberty/strrchr.c @@ -5,7 +5,7 @@ @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. diff --git a/libiberty/strstr.c b/libiberty/strstr.c index e7360341bc0..ffe1d10fc9e 100644 --- a/libiberty/strstr.c +++ b/libiberty/strstr.c @@ -6,8 +6,8 @@ @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}. diff --git a/libiberty/strtol.c b/libiberty/strtol.c index 028d6101dfd..fa84a2e8d2d 100644 --- a/libiberty/strtol.c +++ b/libiberty/strtol.c @@ -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} 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 diff --git a/libiberty/xatexit.c b/libiberty/xatexit.c index f5d31503289..6d983a894f4 100644 --- a/libiberty/xatexit.c +++ b/libiberty/xatexit.c @@ -11,7 +11,7 @@ @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. diff --git a/libiberty/xexit.c b/libiberty/xexit.c index 55ca55a7d67..a65690f09c3 100644 --- a/libiberty/xexit.c +++ b/libiberty/xexit.c @@ -22,7 +22,7 @@ Boston, MA 02111-1307, USA. */ @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 diff --git a/libiberty/xmalloc.c b/libiberty/xmalloc.c index cb923d96f64..3fc23a91c7a 100644 --- a/libiberty/xmalloc.c +++ b/libiberty/xmalloc.c @@ -22,7 +22,8 @@ Boston, MA 02111-1307, USA. */ @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.