X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=libiberty%2Flibiberty.texi;h=f4af66d40b9185a3cd0bc10ed26c430ccc875c81;hb=ef53be89160126f2fa5dec8f1ec3bd6d99fb0681;hp=9181b0f4621fc82c6403b3e1adecc526a79f8492;hpb=39423523167c47f72822dbb9eb3ab4a0dfeafe68;p=deliverable%2Fbinutils-gdb.git diff --git a/libiberty/libiberty.texi b/libiberty/libiberty.texi index 9181b0f462..f4af66d40b 100644 --- a/libiberty/libiberty.texi +++ b/libiberty/libiberty.texi @@ -6,20 +6,29 @@ @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} @end macro -@c The edition date is written in three locations. Search for 'thedate'. @ifinfo This manual describes the GNU @libib library of utility subroutines. -This edition accompanies GCC 3, September 2001. -Copyright @copyright{} 2001 Free Software Foundation, Inc. +Copyright @copyright{} 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, +2009, 2010 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 + under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the @@ -35,27 +44,26 @@ notice identical to this one except for the removal of this paragraph @end ifinfo -@c The edition date is written in three locations. Search for 'thedate'. @titlepage @title @sc{gnu} libiberty -@subtitle September 2001 -@subtitle for GCC 3 @author Phil Edwards et al. @page @vskip 0pt plus 1filll -Copyright @copyright{} 2001 Free Software Foundation, Inc. +Copyright @copyright{} 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, +2009, 2010 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 + under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''. @end titlepage - +@contents +@page @ifnottex @node Top,Using,, @@ -65,9 +73,6 @@ The @libib{} library is a collection of subroutines used by various GNU programs. It is available under the Library General Public License; for more information, see @ref{Library Copying}. -@c The edition date is written in three locations. Search for 'thedate'. -This edition accompanies GCC 3, September 2001. - @end ifnottex @menu @@ -77,15 +82,13 @@ This edition accompanies GCC 3, September 2001. * Functions:: Available functions, macros, and global variables. -* Obstacks:: Object Stacks. - * Licenses:: The various licenses under which libiberty sources are distributed. * 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 +107,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 +124,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 +141,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 +162,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 +199,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 +226,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 +241,29 @@ central location from which to use, maintain, and distribute them. * Obstacks:: Stacks of arbitrary objects. @end menu +@c This is generated from the glibc manual using contrib/make-obstacks-texi.pl +@include obstacks.texi -@node Functions,Obstacks,Overview,Top +@node Functions @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 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,11 +306,10 @@ 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 -@contents @bye