Commit 996c0cb0 by Ralf Wildenhues Committed by Ralf Wildenhues

libiberty: documentation markup and order fixes.

libiberty/:
	* splay-tree.c: Escape wrapping newlines in texinfo markup
	with '@', to fix function declaration output rendering.
	* gather-docs: Relax and improve macro name matching to actually
	match all current names and to allow input line wrapping.
	* bsearch.c, concat.c, crc32.c, fnmatch.txh, fopen_unlocked.c,
	hashtab.c, insque.c, make-relative-prefix.c, memchr.c, memcmp.c,
	memcpy.c, memmem.c, memmove.c, mempcpy.c, memset.c,
	pexecute.txh, random.c, setenv.c, setproctitle.c,
	simple-object.txh, snprintf.c, stpncpy.c, strncmp.c, strtod.c,
	strtol.c, vasprintf.c, vprintf.c, vsnprintf.c, xmemdup.c:
	Wrap long texinfo input lines.
	* functions.texi: Regenerate.

From-SVN: r169783
parent 4deef538
2011-02-03 Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
* splay-tree.c: Escape wrapping newlines in texinfo markup
with '@', to fix function declaration output rendering.
* gather-docs: Relax and improve macro name matching to actually
match all current names and to allow input line wrapping.
* bsearch.c, concat.c, crc32.c, fnmatch.txh, fopen_unlocked.c,
hashtab.c, insque.c, make-relative-prefix.c, memchr.c, memcmp.c,
memcpy.c, memmem.c, memmove.c, mempcpy.c, memset.c,
pexecute.txh, random.c, setenv.c, setproctitle.c,
simple-object.txh, snprintf.c, stpncpy.c, strncmp.c, strtod.c,
strtol.c, vasprintf.c, vprintf.c, vsnprintf.c, xmemdup.c:
Wrap long texinfo input lines.
* functions.texi: Regenerate.
2011-01-18 Mike Frysinger <vapier@gentoo.org> 2011-01-18 Mike Frysinger <vapier@gentoo.org>
* .gitignore: New file. * .gitignore: New file.
......
...@@ -30,7 +30,9 @@ ...@@ -30,7 +30,9 @@
/* /*
@deftypefn Supplemental void* bsearch (const void *@var{key}, const void *@var{base}, size_t @var{nmemb}, size_t @var{size}, int (*@var{compar})(const void *, const void *)) @deftypefn Supplemental void* bsearch (const void *@var{key}, @
const void *@var{base}, size_t @var{nmemb}, size_t @var{size}, @
int (*@var{compar})(const void *, const void *))
Performs a search over an array of @var{nmemb} elements pointed to by Performs a search over an array of @var{nmemb} elements pointed to by
@var{base} for a member that matches the object pointed to by @var{key}. @var{base} for a member that matches the object pointed to by @var{key}.
......
/* Concatenate variable number of strings. /* Concatenate variable number of strings.
Copyright (C) 1991, 1994, 2001 Free Software Foundation, Inc. Copyright (C) 1991, 1994, 2001, 2011 Free Software Foundation, Inc.
Written by Fred Fish @ Cygnus Support Written by Fred Fish @ Cygnus Support
This file is part of the libiberty library. This file is part of the libiberty library.
...@@ -21,7 +21,8 @@ Boston, MA 02110-1301, USA. */ ...@@ -21,7 +21,8 @@ Boston, MA 02110-1301, USA. */
/* /*
@deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @dots{}, @code{NULL}) @deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @
@dots{}, @code{NULL})
Concatenate zero or more of strings and return the result in freshly Concatenate zero or more of strings and return the result in freshly
@code{xmalloc}ed memory. Returns @code{NULL} if insufficient memory is @code{xmalloc}ed memory. Returns @code{NULL} if insufficient memory is
...@@ -170,7 +171,8 @@ concat (const char *first, ...) ...@@ -170,7 +171,8 @@ concat (const char *first, ...)
/* /*
@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @dots{}, @code{NULL}) @deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @
@dots{}, @code{NULL})
Same as @code{concat}, except that if @var{optr} is not @code{NULL} it Same as @code{concat}, except that if @var{optr} is not @code{NULL} it
is freed after the string is created. This is intended to be useful is freed after the string is created. This is intended to be useful
......
/* crc32.c /* crc32.c
Copyright (C) 2009 Free Software Foundation, Inc. Copyright (C) 2009, 2011 Free Software Foundation, Inc.
This file is part of the libiberty library. This file is part of the libiberty library.
...@@ -138,7 +138,8 @@ static const unsigned int crc32_table[] = ...@@ -138,7 +138,8 @@ static const unsigned int crc32_table[] =
/* /*
@deftypefn Extension unsigned int crc32 (const unsigned char *@var{buf}, int @var{len}, unsigned int @var{init}) @deftypefn Extension {unsigned int} crc32 (const unsigned char *@var{buf}, @
int @var{len}, unsigned int @var{init})
Compute the 32-bit CRC of @var{buf} which has length @var{len}. The Compute the 32-bit CRC of @var{buf} which has length @var{len}. The
starting value is @var{init}; this may be used to compute the CRC of starting value is @var{init}; this may be used to compute the CRC of
......
@deftypefn Replacement int fnmatch (const char *@var{pattern}, const char *@var{string}, int @var{flags}) @deftypefn Replacement int fnmatch (const char *@var{pattern}, @
const char *@var{string}, int @var{flags})
Matches @var{string} against @var{pattern}, returning zero if it Matches @var{string} against @var{pattern}, returning zero if it
matches, @code{FNM_NOMATCH} if not. @var{pattern} may contain the matches, @code{FNM_NOMATCH} if not. @var{pattern} may contain the
......
/* Implement fopen_unlocked and related functions. /* Implement fopen_unlocked and related functions.
Copyright (C) 2005 Free Software Foundation, Inc. Copyright (C) 2005, 2011 Free Software Foundation, Inc.
Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>. Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>.
This file is part of the libiberty library. This file is part of the libiberty library.
...@@ -36,7 +36,8 @@ multi-threaded locking. Otherwise do nothing. ...@@ -36,7 +36,8 @@ multi-threaded locking. Otherwise do nothing.
@end deftypefn @end deftypefn
@deftypefn Extension {FILE *} fopen_unlocked (const char *@var{path}, const char * @var{mode}) @deftypefn Extension {FILE *} fopen_unlocked (const char *@var{path}, @
const char * @var{mode})
Opens and returns a @code{FILE} pointer via @code{fopen}. If the Opens and returns a @code{FILE} pointer via @code{fopen}. If the
operating system supports it, ensure that the stream is setup to avoid operating system supports it, ensure that the stream is setup to avoid
...@@ -45,7 +46,8 @@ unchanged. ...@@ -45,7 +46,8 @@ unchanged.
@end deftypefn @end deftypefn
@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, const char * @var{mode}) @deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, @
const char * @var{mode})
Opens and returns a @code{FILE} pointer via @code{fdopen}. If the Opens and returns a @code{FILE} pointer via @code{fdopen}. If the
operating system supports it, ensure that the stream is setup to avoid operating system supports it, ensure that the stream is setup to avoid
...@@ -54,7 +56,8 @@ unchanged. ...@@ -54,7 +56,8 @@ unchanged.
@end deftypefn @end deftypefn
@deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, const char * @var{mode}, FILE * @var{stream}) @deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, @
const char * @var{mode}, FILE * @var{stream})
Opens and returns a @code{FILE} pointer via @code{freopen}. If the Opens and returns a @code{FILE} pointer via @code{freopen}. If the
operating system supports it, ensure that the stream is setup to avoid operating system supports it, ensure that the stream is setup to avoid
......
#!/usr/bin/perl #!/usr/bin/perl
# -*- perl -*- # -*- perl -*-
# Copyright (C) 2001 # Copyright (C) 2001, 2009, 2011
# Free Software Foundation # Free Software Foundation
# #
# This file is part of the libiberty library. # This file is part of the libiberty library.
...@@ -73,8 +73,8 @@ for $in (@ARGV) { ...@@ -73,8 +73,8 @@ for $in (@ARGV) {
if (/^\@def[a-z]*[a-wyz] /) { if (/^\@def[a-z]*[a-wyz] /) {
($name) = m/[^\(]* ([^\( \t\r\n]+) *\(/; ($name) = m/[^\(]* ([^\( \t\r\n\@]+) *(\(|\@?$)/;
$name =~ s/[ ]*$//; $name =~ s/[ ]*\@?$//;
$key = $name; $key = $name;
$key =~ tr/A-Z/a-z/; $key =~ tr/A-Z/a-z/;
$key =~ s/[^a-z0-9]+/ /g; $key =~ s/[^a-z0-9]+/ /g;
......
...@@ -333,9 +333,9 @@ htab_create_alloc_ex (size_t size, htab_hash hash_f, htab_eq eq_f, ...@@ -333,9 +333,9 @@ htab_create_alloc_ex (size_t size, htab_hash hash_f, htab_eq eq_f,
/* /*
@deftypefn Supplemental htab_t htab_create_typed_alloc (size_t @var{size}, @deftypefn Supplemental htab_t htab_create_typed_alloc (size_t @var{size}, @
htab_hash @var{hash_f}, htab_eq @var{eq_f}, htab_del @var{del_f}, htab_hash @var{hash_f}, htab_eq @var{eq_f}, htab_del @var{del_f}, @
htab_alloc @var{alloc_tab_f}, htab_alloc @var{alloc_f}, htab_alloc @var{alloc_tab_f}, htab_alloc @var{alloc_f}, @
htab_free @var{free_f}) htab_free @var{free_f})
This function creates a hash table that uses two different allocators This function creates a hash table that uses two different allocators
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
/* /*
@deftypefn Supplemental void insque (struct qelem *@var{elem}, struct qelem *@var{pred}) @deftypefn Supplemental void insque (struct qelem *@var{elem}, @
struct qelem *@var{pred})
@deftypefnx Supplemental void remque (struct qelem *@var{elem}) @deftypefnx Supplemental void remque (struct qelem *@var{elem})
Routines to manipulate queues built from doubly linked lists. The Routines to manipulate queues built from doubly linked lists. The
......
...@@ -21,7 +21,8 @@ Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA ...@@ -21,7 +21,8 @@ Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
/* /*
@deftypefn Extension {const char*} make_relative_prefix (const char *@var{progname}, const char *@var{bin_prefix}, const char *@var{prefix}) @deftypefn Extension {const char*} make_relative_prefix (const char *@var{progname}, @
const char *@var{bin_prefix}, const char *@var{prefix})
Given three paths @var{progname}, @var{bin_prefix}, @var{prefix}, Given three paths @var{progname}, @var{bin_prefix}, @var{prefix},
return the path that is in the same position relative to return the path that is in the same position relative to
......
/* /*
@deftypefn Supplemental void* memchr (const void *@var{s}, int @var{c}, size_t @var{n}) @deftypefn Supplemental void* memchr (const void *@var{s}, int @var{c}, @
size_t @var{n})
This function searches memory starting at @code{*@var{s}} for the This function searches memory starting at @code{*@var{s}} for the
character @var{c}. The search only ends with the first occurrence of character @var{c}. The search only ends with the first occurrence of
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
/* /*
@deftypefn Supplemental int memcmp (const void *@var{x}, const void *@var{y}, size_t @var{count}) @deftypefn Supplemental int memcmp (const void *@var{x}, const void *@var{y}, @
size_t @var{count})
Compares the first @var{count} bytes of two areas of memory. Returns Compares the first @var{count} bytes of two areas of memory. Returns
zero if they are the same, a value less than zero if @var{x} is zero if they are the same, a value less than zero if @var{x} is
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
/* /*
@deftypefn Supplemental void* memcpy (void *@var{out}, const void *@var{in}, size_t @var{length}) @deftypefn Supplemental void* memcpy (void *@var{out}, const void *@var{in}, @
size_t @var{length})
Copies @var{length} bytes from memory region @var{in} to region Copies @var{length} bytes from memory region @var{in} to region
@var{out}. Returns a pointer to @var{out}. @var{out}. Returns a pointer to @var{out}.
......
/* Copyright (C) 1991,92,93,94,96,97,98,2000,2004,2007 Free Software Foundation, Inc. /* Copyright (C) 1991,92,93,94,96,97,98,2000,2004,2007,2011 Free Software Foundation, Inc.
This file is part of the GNU C Library. This file is part of the GNU C Library.
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
...@@ -17,7 +17,8 @@ ...@@ -17,7 +17,8 @@
/* /*
@deftypefn Supplemental void* memmem (const void *@var{haystack}, size_t @var{haystack_len} const void *@var{needle}, size_t @var{needle_len}) @deftypefn Supplemental void* memmem (const void *@var{haystack}, @
size_t @var{haystack_len} const void *@var{needle}, size_t @var{needle_len})
Returns a pointer to the first occurrence of @var{needle} (length Returns a pointer to the first occurrence of @var{needle} (length
@var{needle_len}) in @var{haystack} (length @var{haystack_len}). @var{needle_len}) in @var{haystack} (length @var{haystack_len}).
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
/* /*
@deftypefn Supplemental void* memmove (void *@var{from}, const void *@var{to}, size_t @var{count}) @deftypefn Supplemental void* memmove (void *@var{from}, const void *@var{to}, @
size_t @var{count})
Copies @var{count} bytes from memory area @var{from} to memory area Copies @var{count} bytes from memory area @var{from} to memory area
@var{to}, returning a pointer to @var{to}. @var{to}, returning a pointer to @var{to}.
......
/* Implement the mempcpy function. /* Implement the mempcpy function.
Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc. Copyright (C) 2003, 2004, 2005, 2011 Free Software Foundation, Inc.
Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>. Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>.
This file is part of the libiberty library. This file is part of the libiberty library.
...@@ -20,7 +20,8 @@ Boston, MA 02110-1301, USA. */ ...@@ -20,7 +20,8 @@ Boston, MA 02110-1301, USA. */
/* /*
@deftypefn Supplemental void* mempcpy (void *@var{out}, const void *@var{in}, size_t @var{length}) @deftypefn Supplemental void* mempcpy (void *@var{out}, const void *@var{in}, @
size_t @var{length})
Copies @var{length} bytes from memory region @var{in} to region Copies @var{length} bytes from memory region @var{in} to region
@var{out}. Returns a pointer to @var{out} + @var{length}. @var{out}. Returns a pointer to @var{out} + @var{length}.
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
/* /*
@deftypefn Supplemental void* memset (void *@var{s}, int @var{c}, size_t @var{count}) @deftypefn Supplemental void* memset (void *@var{s}, int @var{c}, @
size_t @var{count})
Sets the first @var{count} bytes of @var{s} to the constant byte Sets the first @var{count} bytes of @var{s} to the constant byte
@var{c}, returning a pointer to @var{s}. @var{c}, returning a pointer to @var{s}.
......
@c -*- mode: texinfo -*- @c -*- mode: texinfo -*-
@deftypefn Extension {struct pex_obj *} pex_init (int @var{flags}, const char *@var{pname}, const char *@var{tempbase}) @deftypefn Extension {struct pex_obj *} pex_init (int @var{flags}, @
const char *@var{pname}, const char *@var{tempbase})
Prepare to execute one or more programs, with standard output of each Prepare to execute one or more programs, with standard output of each
program fed to standard input of the next. This is a system program fed to standard input of the next. This is a system
...@@ -30,7 +31,9 @@ temporary files; it may be @code{NULL} to use a randomly chosen name. ...@@ -30,7 +31,9 @@ temporary files; it may be @code{NULL} to use a randomly chosen name.
@end deftypefn @end deftypefn
@deftypefn Extension {const char *} pex_run (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{executable}, char * const *@var{argv}, const char *@var{outname}, const char *@var{errname}, int *@var{err}) @deftypefn Extension {const char *} pex_run (struct pex_obj *@var{obj}, @
int @var{flags}, const char *@var{executable}, char * const *@var{argv}, @
const char *@var{outname}, const char *@var{errname}, int *@var{err})
Execute one program in a pipeline. On success this returns Execute one program in a pipeline. On success this returns
@code{NULL}. On failure it returns an error message, a statically @code{NULL}. On failure it returns an error message, a statically
...@@ -139,7 +142,10 @@ value, or to 0 if there is no relevant @code{errno}. ...@@ -139,7 +142,10 @@ value, or to 0 if there is no relevant @code{errno}.
@end deftypefn @end deftypefn
@deftypefn Extension {const char *} pex_run_in_environment (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{executable}, char * const *@var{argv}, char * const *@var{env}, int @var{env_size}, const char *@var{outname}, const char *@var{errname}, int *@var{err}) @deftypefn Extension {const char *} pex_run_in_environment (struct pex_obj *@var{obj}, @
int @var{flags}, const char *@var{executable}, char * const *@var{argv}, @
char * const *@var{env}, int @var{env_size}, const char *@var{outname}, @
const char *@var{errname}, int *@var{err})
Execute one program in a pipeline, permitting the environment for the Execute one program in a pipeline, permitting the environment for the
program to be specified. Behaviour and parameters not listed below are program to be specified. Behaviour and parameters not listed below are
...@@ -152,7 +158,8 @@ form @code{VAR=VALUE}, with the exception of the last element that must be ...@@ -152,7 +158,8 @@ form @code{VAR=VALUE}, with the exception of the last element that must be
@end deftypefn @end deftypefn
@deftypefn Extension {FILE *} pex_input_file (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{in_name}) @deftypefn Extension {FILE *} pex_input_file (struct pex_obj *@var{obj}, @
int @var{flags}, const char *@var{in_name})
Return a stream for a temporary file to pass to the first program in Return a stream for a temporary file to pass to the first program in
the pipeline as input. the pipeline as input.
...@@ -169,7 +176,8 @@ binary mode; otherwise, open it in the default mode. Including ...@@ -169,7 +176,8 @@ binary mode; otherwise, open it in the default mode. Including
@code{PEX_BINARY_OUTPUT} in @var{flags} has no effect on Unix. @code{PEX_BINARY_OUTPUT} in @var{flags} has no effect on Unix.
@end deftypefn @end deftypefn
@deftypefn Extension {FILE *} pex_input_pipe (struct pex_obj *@var{obj}, int @var{binary}) @deftypefn Extension {FILE *} pex_input_pipe (struct pex_obj *@var{obj}, @
int @var{binary})
Return a stream @var{fp} for a pipe connected to the standard input of Return a stream @var{fp} for a pipe connected to the standard input of
the first program in the pipeline; @var{fp} is opened for writing. the first program in the pipeline; @var{fp} is opened for writing.
...@@ -213,7 +221,8 @@ the output pipe is you, but you are blocked on the input pipe. ...@@ -213,7 +221,8 @@ the output pipe is you, but you are blocked on the input pipe.
@end deftypefn @end deftypefn
@deftypefn Extension {FILE *} pex_read_output (struct pex_obj *@var{obj}, int @var{binary}) @deftypefn Extension {FILE *} pex_read_output (struct pex_obj *@var{obj}, @
int @var{binary})
Returns a @code{FILE} pointer which may be used to read the standard Returns a @code{FILE} pointer which may be used to read the standard
output of the last program in the pipeline. When this is used, output of the last program in the pipeline. When this is used,
...@@ -225,7 +234,8 @@ it will be closed by @code{pex_free}. ...@@ -225,7 +234,8 @@ it will be closed by @code{pex_free}.
@end deftypefn @end deftypefn
@deftypefn Extension {FILE *} pex_read_err (struct pex_obj *@var{obj}, int @var{binary}) @deftypefn Extension {FILE *} pex_read_err (struct pex_obj *@var{obj}, @
int @var{binary})
Returns a @code{FILE} pointer which may be used to read the standard Returns a @code{FILE} pointer which may be used to read the standard
error of the last program in the pipeline. When this is used, error of the last program in the pipeline. When this is used,
...@@ -238,7 +248,8 @@ it will be closed by @code{pex_free}. ...@@ -238,7 +248,8 @@ it will be closed by @code{pex_free}.
@end deftypefn @end deftypefn
@deftypefn Extension int pex_get_status (struct pex_obj *@var{obj}, int @var{count}, int *@var{vector}) @deftypefn Extension int pex_get_status (struct pex_obj *@var{obj}, @
int @var{count}, int *@var{vector})
Returns the exit status of all programs run using @var{obj}. Returns the exit status of all programs run using @var{obj}.
@var{count} is the number of results expected. The results will be @var{count} is the number of results expected. The results will be
...@@ -247,7 +258,8 @@ to @code{pex_run}. Returns 0 on error, 1 on success. ...@@ -247,7 +258,8 @@ to @code{pex_run}. Returns 0 on error, 1 on success.
@end deftypefn @end deftypefn
@deftypefn Extension int pex_get_times (struct pex_obj *@var{obj}, int @var{count}, struct pex_time *@var{vector}) @deftypefn Extension int pex_get_times (struct pex_obj *@var{obj}, @
int @var{count}, struct pex_time *@var{vector})
Returns the process execution times of all programs run using Returns the process execution times of all programs run using
@var{obj}. @var{count} is the number of results expected. The @var{obj}. @var{count} is the number of results expected. The
...@@ -271,7 +283,10 @@ try to kill the subprocesses. ...@@ -271,7 +283,10 @@ try to kill the subprocesses.
@end deftypefn @end deftypefn
@deftypefn Extension {const char *} pex_one (int @var{flags}, const char *@var{executable}, char * const *@var{argv}, const char *@var{pname}, const char *@var{outname}, const char *@var{errname}, int *@var{status}, int *@var{err}) @deftypefn Extension {const char *} pex_one (int @var{flags}, @
const char *@var{executable}, char * const *@var{argv}, @
const char *@var{pname}, const char *@var{outname}, const char *@var{errname}, @
int *@var{status}, int *@var{err})
An interface to permit the easy execution of a An interface to permit the easy execution of a
single program. The return value and most of the parameters are as single program. The return value and most of the parameters are as
...@@ -283,7 +298,10 @@ be set to the exit status of the program. ...@@ -283,7 +298,10 @@ be set to the exit status of the program.
@end deftypefn @end deftypefn
@deftypefn Extension int pexecute (const char *@var{program}, char * const *@var{argv}, const char *@var{this_pname}, const char *@var{temp_base}, char **@var{errmsg_fmt}, char **@var{errmsg_arg}, int @var{flags}) @deftypefn Extension int pexecute (const char *@var{program}, @
char * const *@var{argv}, const char *@var{this_pname}, @
const char *@var{temp_base}, char **@var{errmsg_fmt}, @
char **@var{errmsg_arg}, int @var{flags})
This is the old interface to execute one or more programs. It is This is the old interface to execute one or more programs. It is
still supported for compatibility purposes, but is no longer still supported for compatibility purposes, but is no longer
......
...@@ -38,7 +38,8 @@ ...@@ -38,7 +38,8 @@
@deftypefn Supplement {long int} random (void) @deftypefn Supplement {long int} random (void)
@deftypefnx Supplement void srandom (unsigned int @var{seed}) @deftypefnx Supplement void srandom (unsigned int @var{seed})
@deftypefnx Supplement void* initstate (unsigned int @var{seed}, void *@var{arg_state}, unsigned long @var{n}) @deftypefnx Supplement void* initstate (unsigned int @var{seed}, @
void *@var{arg_state}, unsigned long @var{n})
@deftypefnx Supplement void* setstate (void *@var{arg_state}) @deftypefnx Supplement void* setstate (void *@var{arg_state})
Random number functions. @code{random} returns a random number in the Random number functions. @code{random} returns a random number in the
......
/* Copyright (C) 1992, 1995, 1996, 1997, 2002 Free Software Foundation, Inc. /* Copyright (C) 1992, 1995, 1996, 1997, 2002, 2011 Free Software Foundation,
Inc.
This file based on setenv.c in the GNU C Library. This file based on setenv.c in the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or The GNU C Library is free software; you can redistribute it and/or
...@@ -19,7 +20,8 @@ ...@@ -19,7 +20,8 @@
/* /*
@deftypefn Supplemental int setenv (const char *@var{name}, const char *@var{value}, int @var{overwrite}) @deftypefn Supplemental int setenv (const char *@var{name}, @
const char *@var{value}, int @var{overwrite})
@deftypefnx Supplemental void unsetenv (const char *@var{name}) @deftypefnx Supplemental void unsetenv (const char *@var{name})
@code{setenv} adds @var{name} to the environment with value @code{setenv} adds @var{name} to the environment with value
......
/* Set the title of a process. /* Set the title of a process.
Copyright (C) 2010 Free Software Foundation, Inc. Copyright (C) 2010, 2011 Free Software Foundation, Inc.
This file is part of the libiberty library. This file is part of the libiberty library.
Libiberty is free software; you can redistribute it and/or Libiberty is free software; you can redistribute it and/or
...@@ -28,7 +28,7 @@ Boston, MA 02110-1301, USA. */ ...@@ -28,7 +28,7 @@ Boston, MA 02110-1301, USA. */
/* /*
@deftypefn Supplemental void setproctitle (const char *@var{fmt} ...) @deftypefn Supplemental void setproctitle (const char *@var{fmt}, ...)
Set the title of a process to @var{fmt}. va args not supported for now, Set the title of a process to @var{fmt}. va args not supported for now,
but defined for compatibility with BSD. but defined for compatibility with BSD.
......
@c -*- mode: texinfo -*- @c -*- mode: texinfo -*-
@deftypefn Extension {simple_object_read *} simple_object_open_read (int @var{descriptor}, off_t @var{offset}, const char *{segment_name}, const char **@var{errmsg}, int *@var{err}) @deftypefn Extension {simple_object_read *} simple_object_open_read @
(int @var{descriptor}, off_t @var{offset}, const char *{segment_name}, @
const char **@var{errmsg}, int *@var{err})
Opens an object file for reading. Creates and returns an Opens an object file for reading. Creates and returns an
@code{simple_object_read} pointer which may be passed to other @code{simple_object_read} pointer which may be passed to other
...@@ -22,7 +24,10 @@ an errno value or @code{0} if there is no relevant errno. ...@@ -22,7 +24,10 @@ an errno value or @code{0} if there is no relevant errno.
@end deftypefn @end deftypefn
@deftypefn Extension {const char *} simple_object_find_sections (simple_object_read *@var{simple_object}, int (*@var{pfn}) (void *@var{data}, const char *@var{name}, off_t @var{offset}, off_t @var{length}), void *@var{data}, int *@var{err}) @deftypefn Extension {const char *} simple_object_find_sections @
(simple_object_read *@var{simple_object}, int (*@var{pfn}) (void *@var{data}, @
const char *@var{name}, off_t @var{offset}, off_t @var{length}), @
void *@var{data}, int *@var{err})
This function calls @var{pfn} for each section in @var{simple_object}. This function calls @var{pfn} for each section in @var{simple_object}.
It calls @var{pfn} with the section name, the offset within the file It calls @var{pfn} with the section name, the offset within the file
...@@ -41,7 +46,9 @@ or @code{0} if there is no relevant errno. ...@@ -41,7 +46,9 @@ or @code{0} if there is no relevant errno.
@end deftypefn @end deftypefn
@deftypefn Extension {int} simple_object_find_section (simple_object_read *@var{simple_object} off_t *@var{offset}, off_t *@var{length}, const char **@var{errmsg}, int *@var{err}) @deftypefn Extension {int} simple_object_find_section @
(simple_object_read *@var{simple_object} off_t *@var{offset}, @
off_t *@var{length}, const char **@var{errmsg}, int *@var{err})
Look for the section @var{name} in @var{simple_object}. This returns Look for the section @var{name} in @var{simple_object}. This returns
information for the first section with that name. information for the first section with that name.
...@@ -63,14 +70,16 @@ relevant errno. ...@@ -63,14 +70,16 @@ relevant errno.
@end deftypefn @end deftypefn
@deftypefn Extension {void} simple_object_release_read (simple_object_read *@var{simple_object}) @deftypefn Extension {void} simple_object_release_read @
(simple_object_read *@var{simple_object})
Release all resources associated with @var{simple_object}. This does Release all resources associated with @var{simple_object}. This does
not close the file descriptor. not close the file descriptor.
@end deftypefn @end deftypefn
@deftypefn Extension {simple_object_attributes *} simple_object_fetch_attributes (simple_object_read *@var{simple_object}, const char **@var{errmsg}, int *@var{err}) @deftypefn Extension {simple_object_attributes *} simple_object_fetch_attributes @
(simple_object_read *@var{simple_object}, const char **@var{errmsg}, int *@var{err})
Fetch the attributes of @var{simple_object}. The attributes are Fetch the attributes of @var{simple_object}. The attributes are
internal information such as the format of the object file, or the internal information such as the format of the object file, or the
...@@ -84,7 +93,9 @@ error message, and sets @code{*@var{err}} to an errno value or ...@@ -84,7 +93,9 @@ error message, and sets @code{*@var{err}} to an errno value or
@end deftypefn @end deftypefn
@deftypefn Extension {const char *} simple_object_attributes_compare (simple_object_attributes *@var{attrs1}, simple_object_attributes *@var{attrs2}, int *@var{err}) @deftypefn Extension {const char *} simple_object_attributes_compare @
(simple_object_attributes *@var{attrs1}, simple_object_attributes *@var{attrs2}, @
int *@var{err})
Compare @var{attrs1} and @var{attrs2}. If they could be linked Compare @var{attrs1} and @var{attrs2}. If they could be linked
together without error, return @code{NULL}. Otherwise, return an together without error, return @code{NULL}. Otherwise, return an
...@@ -93,13 +104,16 @@ if there is no relevant errno. ...@@ -93,13 +104,16 @@ if there is no relevant errno.
@end deftypefn @end deftypefn
@deftypefn Extension {void} simple_object_release_attributes (simple_object_attributes *@var{attrs}) @deftypefn Extension {void} simple_object_release_attributes @
(simple_object_attributes *@var{attrs})
Release all resources associated with @var{attrs}. Release all resources associated with @var{attrs}.
@end deftypefn @end deftypefn
@deftypefn Extension {simple_object_write *} simple_object_start_write (simple_object_attributes @var{attrs}, const char *@var{segment_name}, const char **@var{errmsg}, int *@var{err}) @deftypefn Extension {simple_object_write *} simple_object_start_write @
(simple_object_attributes @var{attrs}, const char *@var{segment_name}, @
const char **@var{errmsg}, int *@var{err})
Start creating a new object file using the object file format Start creating a new object file using the object file format
described in @var{attrs}. You must fetch attribute information from described in @var{attrs}. You must fetch attribute information from
...@@ -117,7 +131,9 @@ to an errno value or @code{0} if there is no relevant errno. ...@@ -117,7 +131,9 @@ to an errno value or @code{0} if there is no relevant errno.
@end deftypefn @end deftypefn
@deftypefn Extension {simple_object_write_section *} simple_object_write_create_section (simple_object_write *@var{simple_object}, const char *@var{name}, unsigned int @var{align}, const char **@var{errmsg}, int *@var{err}) @deftypefn Extension {simple_object_write_section *} simple_object_write_create_section @
(simple_object_write *@var{simple_object}, const char *@var{name}, @
unsigned int @var{align}, const char **@var{errmsg}, int *@var{err})
Add a section to @var{simple_object}. @var{name} is the name of the Add a section to @var{simple_object}. @var{name} is the name of the
new section. @var{align} is the required alignment expressed as the new section. @var{align} is the required alignment expressed as the
...@@ -134,7 +150,10 @@ error message, and sets @code{*@var{err}} to an errno value or ...@@ -134,7 +150,10 @@ error message, and sets @code{*@var{err}} to an errno value or
@end deftypefn @end deftypefn
@deftypefn Extension {const char *} simple_object_write_add_data (simple_object_write *@var{simple_object}, simple_object_write_section *@var{section}, const void *@var{buffer}, size_t @var{size}, int @var{copy}, int *@var{err}) @deftypefn Extension {const char *} simple_object_write_add_data @
(simple_object_write *@var{simple_object}, @
simple_object_write_section *@var{section}, const void *@var{buffer}, @
size_t @var{size}, int @var{copy}, int *@var{err})
Add data @var{buffer}/@var{size} to @var{section} in Add data @var{buffer}/@var{size} to @var{section} in
@var{simple_object}. If @var{copy} is non-zero, the data will be @var{simple_object}. If @var{copy} is non-zero, the data will be
...@@ -148,7 +167,8 @@ no relevant erro. ...@@ -148,7 +167,8 @@ no relevant erro.
@end deftypefn @end deftypefn
@deftypefn Extension {const char *} simple_object_write_to_file (simple_object_write *@var{simple_object}, int @var{descriptor}, int *@var{err}) @deftypefn Extension {const char *} simple_object_write_to_file @
(simple_object_write *@var{simple_object}, int @var{descriptor}, int *@var{err})
Write the complete object file to @var{descriptor}, an open file Write the complete object file to @var{descriptor}, an open file
descriptor. This writes out all the data accumulated by calls to descriptor. This writes out all the data accumulated by calls to
...@@ -161,7 +181,8 @@ there is no relevant errno. ...@@ -161,7 +181,8 @@ there is no relevant errno.
@end deftypefn @end deftypefn
@deftypefn Extension {void} simple_object_release_write (simple_object_write *@var{simple_object}) @deftypefn Extension {void} simple_object_release_write @
(simple_object_write *@var{simple_object})
Release all resources associated with @var{simple_object}. Release all resources associated with @var{simple_object}.
......
/* Implement the snprintf function. /* Implement the snprintf function.
Copyright (C) 2003 Free Software Foundation, Inc. Copyright (C) 2003, 2011 Free Software Foundation, Inc.
Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>. Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>.
This file is part of the libiberty library. This library is free This file is part of the libiberty library. This library is free
...@@ -25,7 +25,8 @@ the executable file might be covered by the GNU General Public License. */ ...@@ -25,7 +25,8 @@ the executable file might be covered by the GNU General Public License. */
/* /*
@deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, ...) @deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, @
const char *@var{format}, ...)
This function is similar to @code{sprintf}, but it will write to This function is similar to @code{sprintf}, but it will write to
@var{buf} at most @code{@var{n}-1} bytes of text, followed by a @var{buf} at most @code{@var{n}-1} bytes of text, followed by a
......
/* A splay-tree datatype. /* A splay-tree datatype.
Copyright (C) 1998, 1999, 2000, 2001, 2009, Copyright (C) 1998, 1999, 2000, 2001, 2009,
2010 Free Software Foundation, Inc. 2010, 2011 Free Software Foundation, Inc.
Contributed by Mark Mitchell (mark@markmitchell.com). Contributed by Mark Mitchell (mark@markmitchell.com).
This file is part of GNU CC. This file is part of GNU CC.
...@@ -300,13 +300,13 @@ splay_tree_new_with_allocator (splay_tree_compare_fn compare_fn, ...@@ -300,13 +300,13 @@ splay_tree_new_with_allocator (splay_tree_compare_fn compare_fn,
/* /*
@deftypefn Supplemental splay_tree splay_tree_new_with_typed_alloc @deftypefn Supplemental splay_tree splay_tree_new_with_typed_alloc @
(splay_tree_compare_fn @var{compare_fn}, (splay_tree_compare_fn @var{compare_fn}, @
splay_tree_delete_key_fn @var{delete_key_fn}, splay_tree_delete_key_fn @var{delete_key_fn}, @
splay_tree_delete_value_fn @var{delete_value_fn}, splay_tree_delete_value_fn @var{delete_value_fn}, @
splay_tree_allocate_fn @var{tree_allocate_fn}, splay_tree_allocate_fn @var{tree_allocate_fn}, @
splay_tree_allocate_fn @var{node_allocate_fn}, splay_tree_allocate_fn @var{node_allocate_fn}, @
splay_tree_deallocate_fn @var{deallocate_fn}, splay_tree_deallocate_fn @var{deallocate_fn}, @
void * @var{allocate_data}) void * @var{allocate_data})
This function creates a splay tree that uses two different allocators This function creates a splay tree that uses two different allocators
......
/* Implement the stpncpy function. /* Implement the stpncpy function.
Copyright (C) 2003 Free Software Foundation, Inc. Copyright (C) 2003, 2011 Free Software Foundation, Inc.
Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>. Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>.
This file is part of the libiberty library. This file is part of the libiberty library.
...@@ -20,7 +20,8 @@ Boston, MA 02110-1301, USA. */ ...@@ -20,7 +20,8 @@ Boston, MA 02110-1301, USA. */
/* /*
@deftypefn Supplemental char* stpncpy (char *@var{dst}, const char *@var{src}, size_t @var{len}) @deftypefn Supplemental char* stpncpy (char *@var{dst}, const char *@var{src}, @
size_t @var{len})
Copies the string @var{src} into @var{dst}, copying exactly @var{len} Copies the string @var{src} into @var{dst}, copying exactly @var{len}
and padding with zeros if necessary. If @var{len} < strlen(@var{src}) and padding with zeros if necessary. If @var{len} < strlen(@var{src})
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
/* /*
@deftypefn Supplemental int strncmp (const char *@var{s1}, const char *@var{s2}, size_t @var{n}) @deftypefn Supplemental int strncmp (const char *@var{s1}, @
const char *@var{s2}, size_t @var{n})
Compares the first @var{n} bytes of two strings, returning a value as Compares the first @var{n} bytes of two strings, returning a value as
@code{strcmp}. @code{strcmp}.
......
/* Implementation of strtod for systems with atof. /* Implementation of strtod for systems with atof.
Copyright (C) 1991, 1995, 2002 Free Software Foundation, Inc. Copyright (C) 1991, 1995, 2002, 2011 Free Software Foundation, Inc.
This file is part of the libiberty library. This library is free This file is part of the libiberty library. This library is free
software; you can redistribute it and/or modify it under the software; you can redistribute it and/or modify it under the
...@@ -24,7 +24,8 @@ the executable file might be covered by the GNU General Public License. */ ...@@ -24,7 +24,8 @@ the executable file might be covered by the GNU General Public License. */
/* /*
@deftypefn Supplemental double strtod (const char *@var{string}, char **@var{endptr}) @deftypefn Supplemental double strtod (const char *@var{string}, @
char **@var{endptr})
This ISO C function converts the initial portion of @var{string} to a This ISO C function converts the initial portion of @var{string} to a
@code{double}. If @var{endptr} is not @code{NULL}, a pointer to the @code{double}. If @var{endptr} is not @code{NULL}, a pointer to the
......
...@@ -30,8 +30,10 @@ ...@@ -30,8 +30,10 @@
/* /*
@deftypefn Supplemental {long int} strtol (const char *@var{string}, char **@var{endptr}, int @var{base}) @deftypefn Supplemental {long int} strtol (const char *@var{string}, @
@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, char **@var{endptr}, int @var{base}) char **@var{endptr}, int @var{base})
@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, @
char **@var{endptr}, int @var{base})
The @code{strtol} function converts the string in @var{string} to a The @code{strtol} function converts the string in @var{string} to a
long integer value according to the given @var{base}, which must be long integer value according to the given @var{base}, which must be
......
/* Like vsprintf but provides a pointer to malloc'd storage, which must /* Like vsprintf but provides a pointer to malloc'd storage, which must
be freed by the caller. be freed by the caller.
Copyright (C) 1994, 2003 Free Software Foundation, Inc. Copyright (C) 1994, 2003, 2011 Free Software Foundation, Inc.
This file is part of the libiberty library. This file is part of the libiberty library.
Libiberty is free software; you can redistribute it and/or Libiberty is free software; you can redistribute it and/or
...@@ -44,7 +44,8 @@ int global_total_width; ...@@ -44,7 +44,8 @@ int global_total_width;
/* /*
@deftypefn Extension int vasprintf (char **@var{resptr}, const char *@var{format}, va_list @var{args}) @deftypefn Extension int vasprintf (char **@var{resptr}, @
const char *@var{format}, va_list @var{args})
Like @code{vsprintf}, but instead of passing a pointer to a buffer, Like @code{vsprintf}, but instead of passing a pointer to a buffer,
you pass a pointer to a pointer. This function will compute the size you pass a pointer to a pointer. This function will compute the size
......
/* /*
@deftypefn Supplemental int vprintf (const char *@var{format}, va_list @var{ap}) @deftypefn Supplemental int vprintf (const char *@var{format}, va_list @var{ap})
@deftypefnx Supplemental int vfprintf (FILE *@var{stream}, const char *@var{format}, va_list @var{ap}) @deftypefnx Supplemental int vfprintf (FILE *@var{stream}, @
@deftypefnx Supplemental int vsprintf (char *@var{str}, const char *@var{format}, va_list @var{ap}) const char *@var{format}, va_list @var{ap})
@deftypefnx Supplemental int vsprintf (char *@var{str}, @
const char *@var{format}, va_list @var{ap})
These functions are the same as @code{printf}, @code{fprintf}, and These functions are the same as @code{printf}, @code{fprintf}, and
@code{sprintf}, respectively, except that they are called with a @code{sprintf}, respectively, except that they are called with a
......
/* Implement the vsnprintf function. /* Implement the vsnprintf function.
Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc. Copyright (C) 2003, 2004, 2005, 2011 Free Software Foundation, Inc.
Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>. Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>.
This file is part of the libiberty library. This library is free This file is part of the libiberty library. This library is free
...@@ -25,7 +25,8 @@ the executable file might be covered by the GNU General Public License. */ ...@@ -25,7 +25,8 @@ the executable file might be covered by the GNU General Public License. */
/* /*
@deftypefn Supplemental int vsnprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, va_list @var{ap}) @deftypefn Supplemental int vsnprintf (char *@var{buf}, size_t @var{n}, @
const char *@var{format}, va_list @var{ap})
This function is similar to @code{vsprintf}, but it will write to This function is similar to @code{vsprintf}, but it will write to
@var{buf} at most @code{@var{n}-1} bytes of text, followed by a @var{buf} at most @code{@var{n}-1} bytes of text, followed by a
......
...@@ -4,7 +4,8 @@ ...@@ -4,7 +4,8 @@
/* /*
@deftypefn Replacement void* xmemdup (void *@var{input}, size_t @var{copy_size}, size_t @var{alloc_size}) @deftypefn Replacement void* xmemdup (void *@var{input}, @
size_t @var{copy_size}, size_t @var{alloc_size})
Duplicates a region of memory without fail. First, @var{alloc_size} bytes Duplicates a region of memory without fail. First, @var{alloc_size} bytes
are allocated, then @var{copy_size} bytes from @var{input} are copied into are allocated, then @var{copy_size} bytes from @var{input} are copied into
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment