diff options
author | Ralf Wildenhues <Ralf.Wildenhues@gmx.de> | 2011-02-03 07:23:59 +0000 |
---|---|---|
committer | Ralf Wildenhues <Ralf.Wildenhues@gmx.de> | 2011-02-03 07:23:59 +0000 |
commit | d4d868a28076273e828f299e896dbc1af827208a (patch) | |
tree | 450a54c91a2a493146b9c9b1ea89f764f5fd3765 /libiberty | |
parent | 876c33db725954517df40daa09c6062f9431d68b (diff) | |
download | binutils-d4d868a28076273e828f299e896dbc1af827208a.zip binutils-d4d868a28076273e828f299e896dbc1af827208a.tar.gz binutils-d4d868a28076273e828f299e896dbc1af827208a.tar.bz2 |
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.
Diffstat (limited to 'libiberty')
33 files changed, 370 insertions, 208 deletions
diff --git a/libiberty/ChangeLog b/libiberty/ChangeLog index bc02da4..da4b2be 100644 --- a/libiberty/ChangeLog +++ b/libiberty/ChangeLog @@ -1,3 +1,22 @@ +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> + + * .gitignore: New file. + 2010-12-08 Doug Evans <dje@google.com> * splay-tree.c (splay_tree_foreach_helper): Remove arg `sp', diff --git a/libiberty/bsearch.c b/libiberty/bsearch.c index 771d5de..35fad19 100644 --- a/libiberty/bsearch.c +++ b/libiberty/bsearch.c @@ -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 @var{base} for a member that matches the object pointed to by @var{key}. diff --git a/libiberty/concat.c b/libiberty/concat.c index 1f329ea..9779d56 100644 --- a/libiberty/concat.c +++ b/libiberty/concat.c @@ -1,5 +1,5 @@ /* 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 This file is part of the libiberty library. @@ -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 @code{xmalloc}ed memory. Returns @code{NULL} if insufficient memory is @@ -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 is freed after the string is created. This is intended to be useful diff --git a/libiberty/crc32.c b/libiberty/crc32.c index c12916b..12d9be0 100644 --- a/libiberty/crc32.c +++ b/libiberty/crc32.c @@ -1,5 +1,5 @@ /* 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. @@ -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 starting value is @var{init}; this may be used to compute the CRC of diff --git a/libiberty/fnmatch.txh b/libiberty/fnmatch.txh index 92e11bc..b5a9373 100644 --- a/libiberty/fnmatch.txh +++ b/libiberty/fnmatch.txh @@ -1,4 +1,5 @@ -@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, @code{FNM_NOMATCH} if not. @var{pattern} may contain the diff --git a/libiberty/fopen_unlocked.c b/libiberty/fopen_unlocked.c index 3c3cefe..d1f78c4 100644 --- a/libiberty/fopen_unlocked.c +++ b/libiberty/fopen_unlocked.c @@ -1,5 +1,5 @@ /* 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>. This file is part of the libiberty library. @@ -36,7 +36,8 @@ multi-threaded locking. Otherwise do nothing. @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 operating system supports it, ensure that the stream is setup to avoid @@ -45,7 +46,8 @@ unchanged. @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 operating system supports it, ensure that the stream is setup to avoid @@ -54,7 +56,8 @@ unchanged. @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 operating system supports it, ensure that the stream is setup to avoid diff --git a/libiberty/functions.texi b/libiberty/functions.texi index b3543cb..f6d0a23 100644 --- a/libiberty/functions.texi +++ b/libiberty/functions.texi @@ -3,47 +3,6 @@ @c Edit the *.c files, configure with --enable-maintainer-mode, @c run 'make stamp-functions' and gather-docs will build a new copy. -@c splay-tree.c:277 -@defvr Extension HOST_CHARSET -This macro indicates the basic character set and encoding used by the -host: more precisely, the encoding used for character constants in -preprocessor @samp{#if} statements (the C "execution character set"). -It is defined by @file{safe-ctype.h}, and will be an integer constant -with one of the following values: - -@ftable @code -@item HOST_CHARSET_UNKNOWN -The host character set is unknown - that is, not one of the next two -possibilities. - -@item HOST_CHARSET_ASCII -The host character set is ASCII. - -@item HOST_CHARSET_EBCDIC -The host character set is some variant of EBCDIC. (Only one of the -nineteen EBCDIC varying characters is tested; exercise caution.) -@end ftable -@end defvr -@deftypefn Supplemental splay_tree splay_tree_new_with_typed_alloc -(splay_tree_compare_fn @var{compare_fn}, -splay_tree_delete_key_fn @var{delete_key_fn}, -splay_tree_delete_value_fn @var{delete_value_fn}, -splay_tree_allocate_fn @var{tree_allocate_fn}, -splay_tree_allocate_fn @var{node_allocate_fn}, -splay_tree_deallocate_fn @var{deallocate_fn}, -void * @var{allocate_data}) - -This function creates a splay tree that uses two different allocators -@var{tree_allocate_fn} and @var{node_allocate_fn} to use for allocating the -tree itself and its nodes respectively. This is useful when variables of -different types need to be allocated with different allocators. - -The splay tree will use @var{compare_fn} to compare nodes, -@var{delete_key_fn} to deallocate keys, and @var{delete_value_fn} to -deallocate values. - -@end deftypefn - @c alloca.c:26 @deftypefn Replacement void* alloca (size_t @var{size}) @@ -110,7 +69,9 @@ Copies @var{length} bytes from memory region @var{in} to region @end deftypefn @c bsearch.c:33 -@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 @var{base} for a member that matches the object pointed to by @var{key}. @@ -177,7 +138,7 @@ not recommended. @end deftypefn -@c make-temp-file.c:95 +@c make-temp-file.c:96 @deftypefn Replacement char* choose_tmpdir () Returns a pointer to a directory path suitable for creating temporary @@ -195,7 +156,8 @@ number of seconds used. @end deftypefn @c concat.c:24 -@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 @code{xmalloc}ed memory. Returns @code{NULL} if insufficient memory is @@ -205,7 +167,8 @@ pointer encountered. Pointers to empty strings are ignored. @end deftypefn @c crc32.c:141 -@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 starting value is @var{init}; this may be used to compute the CRC of @@ -296,8 +259,9 @@ and inode numbers. @end deftypefn -@c fopen_unlocked.c:48 -@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, const char * @var{mode}) +@c fopen_unlocked.c:49 +@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, @ + const char * @var{mode}) Opens and returns a @code{FILE} pointer via @code{fdopen}. If the operating system supports it, ensure that the stream is setup to avoid @@ -333,7 +297,8 @@ and backward slashes are equal. @end deftypefn @c fnmatch.txh:1 -@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, @code{FNM_NOMATCH} if not. @var{pattern} may contain the @@ -383,7 +348,8 @@ Ignores case when performing the comparison. @end deftypefn @c fopen_unlocked.c:39 -@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 operating system supports it, ensure that the stream is setup to avoid @@ -402,8 +368,9 @@ itself. @end deftypefn -@c fopen_unlocked.c:57 -@deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, const char * @var{mode}, FILE * @var{stream}) +@c fopen_unlocked.c:59 +@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 operating system supports it, ensure that the stream is setup to avoid @@ -496,10 +463,32 @@ systems. @end deftypefn +@c safe-ctype.c:25 +@defvr Extension HOST_CHARSET +This macro indicates the basic character set and encoding used by the +host: more precisely, the encoding used for character constants in +preprocessor @samp{#if} statements (the C "execution character set"). +It is defined by @file{safe-ctype.h}, and will be an integer constant +with one of the following values: + +@ftable @code +@item HOST_CHARSET_UNKNOWN +The host character set is unknown - that is, not one of the next two +possibilities. + +@item HOST_CHARSET_ASCII +The host character set is ASCII. + +@item HOST_CHARSET_EBCDIC +The host character set is some variant of EBCDIC. (Only one of the +nineteen EBCDIC varying characters is tested; exercise caution.) +@end ftable +@end defvr + @c hashtab.c:336 -@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_alloc @var{alloc_tab_f}, htab_alloc @var{alloc_f}, +@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_alloc @var{alloc_tab_f}, htab_alloc @var{alloc_f}, @ htab_free @var{free_f}) This function creates a hash table that uses two different allocators @@ -524,7 +513,8 @@ deprecated in new programs in favor of @code{strchr}. @end deftypefn @c insque.c:6 -@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}) Routines to manipulate queues built from doubly linked lists. The @@ -643,7 +633,8 @@ components will be simplified. The returned value will be allocated using @end deftypefn @c make-relative-prefix.c:24 -@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}, return the path that is in the same position relative to @@ -667,7 +658,7 @@ relative prefix can be found, return @code{NULL}. @end deftypefn -@c make-temp-file.c:173 +@c make-temp-file.c:174 @deftypefn Replacement char* make_temp_file (const char *@var{suffix}) Return a temporary file name (as a string) or @code{NULL} if unable to @@ -677,7 +668,8 @@ string is @code{malloc}ed, and the temporary file has been created. @end deftypefn @c memchr.c:3 -@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 character @var{c}. The search only ends with the first occurrence of @@ -690,7 +682,8 @@ returned. @end deftypefn @c memcmp.c:6 -@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 zero if they are the same, a value less than zero if @var{x} is @@ -701,7 +694,8 @@ as if comparing unsigned char arrays. @end deftypefn @c memcpy.c:6 -@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 @var{out}. Returns a pointer to @var{out}. @@ -709,7 +703,8 @@ Copies @var{length} bytes from memory region @var{in} to region @end deftypefn @c memmem.c:20 -@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 @var{needle_len}) in @var{haystack} (length @var{haystack_len}). @@ -718,7 +713,8 @@ Returns @code{NULL} if not found. @end deftypefn @c memmove.c:6 -@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 @var{to}, returning a pointer to @var{to}. @@ -726,7 +722,8 @@ Copies @var{count} bytes from memory area @var{from} to memory area @end deftypefn @c mempcpy.c:23 -@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 @var{out}. Returns a pointer to @var{out} + @var{length}. @@ -734,7 +731,8 @@ Copies @var{length} bytes from memory region @var{in} to region @end deftypefn @c memset.c:6 -@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 @var{c}, returning a pointer to @var{s}. @@ -759,7 +757,7 @@ reading and writing. @end deftypefn -@c pexecute.txh:266 +@c pexecute.txh:278 @deftypefn Extension void pex_free (struct pex_obj @var{obj}) Clean up and free all data associated with @var{obj}. If you have not @@ -768,8 +766,9 @@ try to kill the subprocesses. @end deftypefn -@c pexecute.txh:241 -@deftypefn Extension int pex_get_status (struct pex_obj *@var{obj}, int @var{count}, int *@var{vector}) +@c pexecute.txh:251 +@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}. @var{count} is the number of results expected. The results will be @@ -778,8 +777,9 @@ to @code{pex_run}. Returns 0 on error, 1 on success. @end deftypefn -@c pexecute.txh:250 -@deftypefn Extension int pex_get_times (struct pex_obj *@var{obj}, int @var{count}, struct pex_time *@var{vector}) +@c pexecute.txh:261 +@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 @var{obj}. @var{count} is the number of results expected. The @@ -796,7 +796,8 @@ process times, all the fields will be set to @code{0}. @end deftypefn @c pexecute.txh:2 -@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 program fed to standard input of the next. This is a system @@ -827,8 +828,9 @@ temporary files; it may be @code{NULL} to use a randomly chosen name. @end deftypefn -@c pexecute.txh:155 -@deftypefn Extension {FILE *} pex_input_file (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{in_name}) +@c pexecute.txh:161 +@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 the pipeline as input. @@ -845,8 +847,9 @@ binary mode; otherwise, open it in the default mode. Including @code{PEX_BINARY_OUTPUT} in @var{flags} has no effect on Unix. @end deftypefn -@c pexecute.txh:172 -@deftypefn Extension {FILE *} pex_input_pipe (struct pex_obj *@var{obj}, int @var{binary}) +@c pexecute.txh:179 +@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 the first program in the pipeline; @var{fp} is opened for writing. @@ -890,8 +893,11 @@ the output pipe is you, but you are blocked on the input pipe. @end deftypefn -@c pexecute.txh:274 -@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}) +@c pexecute.txh:286 +@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 single program. The return value and most of the parameters are as @@ -903,8 +909,9 @@ be set to the exit status of the program. @end deftypefn -@c pexecute.txh:228 -@deftypefn Extension {FILE *} pex_read_err (struct pex_obj *@var{obj}, int @var{binary}) +@c pexecute.txh:237 +@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 error of the last program in the pipeline. When this is used, @@ -916,8 +923,9 @@ it will be closed by @code{pex_free}. @end deftypefn -@c pexecute.txh:216 -@deftypefn Extension {FILE *} pex_read_output (struct pex_obj *@var{obj}, int @var{binary}) +@c pexecute.txh:224 +@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 output of the last program in the pipeline. When this is used, @@ -929,8 +937,10 @@ it will be closed by @code{pex_free}. @end deftypefn -@c pexecute.txh:33 -@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}) +@c pexecute.txh:34 +@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 @code{NULL}. On failure it returns an error message, a statically @@ -1039,8 +1049,11 @@ value, or to 0 if there is no relevant @code{errno}. @end deftypefn -@c pexecute.txh:142 -@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}) +@c pexecute.txh:145 +@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 program to be specified. Behaviour and parameters not listed below are @@ -1053,8 +1066,11 @@ form @code{VAR=VALUE}, with the exception of the last element that must be @end deftypefn -@c pexecute.txh:286 -@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}) +@c pexecute.txh:301 +@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 still supported for compatibility purposes, but is no longer @@ -1081,7 +1097,7 @@ name is unset/removed. @end deftypefn -@c pexecute.txh:294 +@c pexecute.txh:312 @deftypefn Extension int pwait (int @var{pid}, int *@var{status}, int @var{flags}) Another part of the old execution interface. @@ -1091,7 +1107,8 @@ Another part of the old execution interface. @c random.c:39 @deftypefn Supplement {long int} random (void) @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}) Random number functions. @code{random} returns a random number in the @@ -1103,8 +1120,9 @@ control over the state of the random number generator. @end deftypefn -@c concat.c:173 -@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @dots{}, @code{NULL}) +@c concat.c:174 +@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 is freed after the string is created. This is intended to be useful @@ -1134,8 +1152,9 @@ deprecated in new programs in favor of @code{strrchr}. @end deftypefn -@c setenv.c:22 -@deftypefn Supplemental int setenv (const char *@var{name}, const char *@var{value}, int @var{overwrite}) +@c setenv.c:23 +@deftypefn Supplemental int setenv (const char *@var{name}, @ + const char *@var{value}, int @var{overwrite}) @deftypefnx Supplemental void unsetenv (const char *@var{name}) @code{setenv} adds @var{name} to the environment with value @@ -1146,8 +1165,8 @@ environment. This implementation is not safe for multithreaded code. @end deftypefn -@c setproctitle.c:30 -@deftypefn Supplemental void setproctitle (const char *@var{fmt} ...) +@c setproctitle.c:31 +@deftypefn Supplemental void setproctitle (const char *@var{fmt}, ...) Set the title of a process to @var{fmt}. va args not supported for now, but defined for compatibility with BSD. @@ -1181,8 +1200,10 @@ be the value @code{1}). @end deftypefn -@c simple-object.txh:87 -@deftypefn Extension {const char *} simple_object_attributes_compare (simple_object_attributes *@var{attrs1}, simple_object_attributes *@var{attrs2}, int *@var{err}) +@c simple-object.txh:96 +@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 together without error, return @code{NULL}. Otherwise, return an @@ -1191,8 +1212,9 @@ if there is no relevant errno. @end deftypefn -@c simple-object.txh:73 -@deftypefn Extension {simple_object_attributes *} simple_object_fetch_attributes (simple_object_read *@var{simple_object}, const char **@var{errmsg}, int *@var{err}) +@c simple-object.txh:81 +@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 internal information such as the format of the object file, or the @@ -1206,8 +1228,10 @@ error message, and sets @code{*@var{err}} to an errno value or @end deftypefn -@c simple-object.txh:44 -@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}) +@c simple-object.txh:49 +@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 information for the first section with that name. @@ -1229,8 +1253,11 @@ relevant errno. @end deftypefn -@c simple-object.txh:25 -@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}) +@c simple-object.txh:27 +@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}. It calls @var{pfn} with the section name, the offset within the file @@ -1250,7 +1277,9 @@ or @code{0} if there is no relevant errno. @end deftypefn @c simple-object.txh:2 -@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 @code{simple_object_read} pointer which may be passed to other @@ -1273,30 +1302,35 @@ an errno value or @code{0} if there is no relevant errno. @end deftypefn -@c simple-object.txh:96 -@deftypefn Extension {void} simple_object_release_attributes (simple_object_attributes *@var{attrs}) +@c simple-object.txh:107 +@deftypefn Extension {void} simple_object_release_attributes @ + (simple_object_attributes *@var{attrs}) Release all resources associated with @var{attrs}. @end deftypefn -@c simple-object.txh:66 -@deftypefn Extension {void} simple_object_release_read (simple_object_read *@var{simple_object}) +@c simple-object.txh:73 +@deftypefn Extension {void} simple_object_release_read @ + (simple_object_read *@var{simple_object}) Release all resources associated with @var{simple_object}. This does not close the file descriptor. @end deftypefn -@c simple-object.txh:164 -@deftypefn Extension {void} simple_object_release_write (simple_object_write *@var{simple_object}) +@c simple-object.txh:184 +@deftypefn Extension {void} simple_object_release_write @ + (simple_object_write *@var{simple_object}) Release all resources associated with @var{simple_object}. @end deftypefn -@c simple-object.txh:102 -@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}) +@c simple-object.txh:114 +@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 described in @var{attrs}. You must fetch attribute information from @@ -1314,8 +1348,11 @@ to an errno value or @code{0} if there is no relevant errno. @end deftypefn -@c simple-object.txh:137 -@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}) +@c simple-object.txh:153 +@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 @var{simple_object}. If @var{copy} is non-zero, the data will be @@ -1329,8 +1366,10 @@ no relevant erro. @end deftypefn -@c simple-object.txh:120 -@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}) +@c simple-object.txh:134 +@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 new section. @var{align} is the required alignment expressed as the @@ -1347,8 +1386,9 @@ error message, and sets @code{*@var{err}} to an errno value or @end deftypefn -@c simple-object.txh:151 -@deftypefn Extension {const char *} simple_object_write_to_file (simple_object_write *@var{simple_object}, int @var{descriptor}, int *@var{err}) +@c simple-object.txh:170 +@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 descriptor. This writes out all the data accumulated by calls to @@ -1362,7 +1402,8 @@ there is no relevant errno. @end deftypefn @c snprintf.c:28 -@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 @var{buf} at most @code{@var{n}-1} bytes of text, followed by a @@ -1385,6 +1426,27 @@ valid until at least the next call. @end deftypefn +@c splay-tree.c:303 +@deftypefn Supplemental splay_tree splay_tree_new_with_typed_alloc @ +(splay_tree_compare_fn @var{compare_fn}, @ +splay_tree_delete_key_fn @var{delete_key_fn}, @ +splay_tree_delete_value_fn @var{delete_value_fn}, @ +splay_tree_allocate_fn @var{tree_allocate_fn}, @ +splay_tree_allocate_fn @var{node_allocate_fn}, @ +splay_tree_deallocate_fn @var{deallocate_fn}, @ +void * @var{allocate_data}) + +This function creates a splay tree that uses two different allocators +@var{tree_allocate_fn} and @var{node_allocate_fn} to use for allocating the +tree itself and its nodes respectively. This is useful when variables of +different types need to be allocated with different allocators. + +The splay tree will use @var{compare_fn} to compare nodes, +@var{delete_key_fn} to deallocate keys, and @var{delete_value_fn} to +deallocate values. + +@end deftypefn + @c stpcpy.c:23 @deftypefn Supplemental char* stpcpy (char *@var{dst}, const char *@var{src}) @@ -1394,7 +1456,8 @@ Copies the string @var{src} into @var{dst}. Returns a pointer to @end deftypefn @c stpncpy.c:23 -@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} and padding with zeros if necessary. If @var{len} < strlen(@var{src}) @@ -1476,7 +1539,8 @@ A case-insensitive @code{strncmp}. @end deftypefn @c strncmp.c:6 -@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 @code{strcmp}. @@ -1553,7 +1617,8 @@ length, the function returns @var{string}. @end deftypefn @c strtod.c:27 -@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 @code{double}. If @var{endptr} is not @code{NULL}, a pointer to the @@ -1573,8 +1638,10 @@ to an errno value. If no translation is found, returns 0. @end deftypefn @c strtol.c:33 -@deftypefn Supplemental {long int} strtol (const char *@var{string}, char **@var{endptr}, int @var{base}) -@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, char **@var{endptr}, int @var{base}) +@deftypefn Supplemental {long int} strtol (const char *@var{string}, @ + 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 long integer value according to the given @var{base}, which must be @@ -1683,7 +1750,8 @@ pointer unchanged. If the @var{stream} is @code{NULL} do nothing. @end deftypefn @c vasprintf.c:47 -@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, you pass a pointer to a pointer. This function will compute the size @@ -1704,8 +1772,10 @@ Emulates @code{vfork} by calling @code{fork} and returning its value. @c vprintf.c:3 @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 vsprintf (char *@var{str}, 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 vsprintf (char *@var{str}, @ + const char *@var{format}, va_list @var{ap}) These functions are the same as @code{printf}, @code{fprintf}, and @code{sprintf}, respectively, except that they are called with a @@ -1717,7 +1787,8 @@ nonstandard but common function @code{_doprnt}. @end deftypefn @c vsnprintf.c:28 -@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 @var{buf} at most @code{@var{n}-1} bytes of text, followed by a @@ -1806,7 +1877,8 @@ You can use this to set the name of the program used by @end deftypefn @c xmemdup.c:7 -@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 are allocated, then @var{copy_size} bytes from @var{input} are copied into diff --git a/libiberty/gather-docs b/libiberty/gather-docs index 94d3fcf..2f1f3b1 100644 --- a/libiberty/gather-docs +++ b/libiberty/gather-docs @@ -1,7 +1,7 @@ #!/usr/bin/perl # -*- perl -*- -# Copyright (C) 2001 +# Copyright (C) 2001, 2009, 2011 # Free Software Foundation # # This file is part of the libiberty library. @@ -73,8 +73,8 @@ for $in (@ARGV) { if (/^\@def[a-z]*[a-wyz] /) { - ($name) = m/[^\(]* ([^\( \t\r\n]+) *\(/; - $name =~ s/[ ]*$//; + ($name) = m/[^\(]* ([^\( \t\r\n\@]+) *(\(|\@?$)/; + $name =~ s/[ ]*\@?$//; $key = $name; $key =~ tr/A-Z/a-z/; $key =~ s/[^a-z0-9]+/ /g; diff --git a/libiberty/hashtab.c b/libiberty/hashtab.c index 359e3ea..dfaec0f 100644 --- a/libiberty/hashtab.c +++ b/libiberty/hashtab.c @@ -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}, -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}, +@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_alloc @var{alloc_tab_f}, htab_alloc @var{alloc_f}, @ htab_free @var{free_f}) This function creates a hash table that uses two different allocators diff --git a/libiberty/insque.c b/libiberty/insque.c index 3473bb9..fd02357 100644 --- a/libiberty/insque.c +++ b/libiberty/insque.c @@ -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}) Routines to manipulate queues built from doubly linked lists. The diff --git a/libiberty/make-relative-prefix.c b/libiberty/make-relative-prefix.c index c98d287..4553a71 100644 --- a/libiberty/make-relative-prefix.c +++ b/libiberty/make-relative-prefix.c @@ -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}, return the path that is in the same position relative to diff --git a/libiberty/memchr.c b/libiberty/memchr.c index 451f817..7448ab9 100644 --- a/libiberty/memchr.c +++ b/libiberty/memchr.c @@ -1,6 +1,7 @@ /* -@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 character @var{c}. The search only ends with the first occurrence of diff --git a/libiberty/memcmp.c b/libiberty/memcmp.c index 39edfca..37db60f 100644 --- a/libiberty/memcmp.c +++ b/libiberty/memcmp.c @@ -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 zero if they are the same, a value less than zero if @var{x} is diff --git a/libiberty/memcpy.c b/libiberty/memcpy.c index 9b5b242..7f67d0b 100644 --- a/libiberty/memcpy.c +++ b/libiberty/memcpy.c @@ -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 @var{out}. Returns a pointer to @var{out}. diff --git a/libiberty/memmem.c b/libiberty/memmem.c index 5d75599..147253f 100644 --- a/libiberty/memmem.c +++ b/libiberty/memmem.c @@ -1,4 +1,4 @@ -/* 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 program is free software; you can redistribute it and/or modify @@ -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 @var{needle_len}) in @var{haystack} (length @var{haystack_len}). diff --git a/libiberty/memmove.c b/libiberty/memmove.c index 06a24fc..ebda7cb 100644 --- a/libiberty/memmove.c +++ b/libiberty/memmove.c @@ -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 @var{to}, returning a pointer to @var{to}. diff --git a/libiberty/mempcpy.c b/libiberty/mempcpy.c index beda7df..f85a07f 100644 --- a/libiberty/mempcpy.c +++ b/libiberty/mempcpy.c @@ -1,5 +1,5 @@ /* 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>. This file is part of the libiberty library. @@ -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 @var{out}. Returns a pointer to @var{out} + @var{length}. diff --git a/libiberty/memset.c b/libiberty/memset.c index 1951ad6..4766689 100644 --- a/libiberty/memset.c +++ b/libiberty/memset.c @@ -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 @var{c}, returning a pointer to @var{s}. diff --git a/libiberty/pexecute.txh b/libiberty/pexecute.txh index 8baf9a0..c3e4038 100644 --- a/libiberty/pexecute.txh +++ b/libiberty/pexecute.txh @@ -1,5 +1,6 @@ @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 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. @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 @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}. @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 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 @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 the pipeline as input. @@ -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. @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 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. @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 output of the last program in the pipeline. When this is used, @@ -225,7 +234,8 @@ it will be closed by @code{pex_free}. @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 error of the last program in the pipeline. When this is used, @@ -238,7 +248,8 @@ it will be closed by @code{pex_free}. @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}. @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. @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 @var{obj}. @var{count} is the number of results expected. The @@ -271,7 +283,10 @@ try to kill the subprocesses. @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 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. @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 still supported for compatibility purposes, but is no longer diff --git a/libiberty/random.c b/libiberty/random.c index c306698..b1d3c6c 100644 --- a/libiberty/random.c +++ b/libiberty/random.c @@ -38,7 +38,8 @@ @deftypefn Supplement {long int} random (void) @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}) Random number functions. @code{random} returns a random number in the diff --git a/libiberty/setenv.c b/libiberty/setenv.c index 355af5a..96917d5 100644 --- a/libiberty/setenv.c +++ b/libiberty/setenv.c @@ -1,4 +1,5 @@ -/* 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. The GNU C Library is free software; you can redistribute it and/or @@ -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}) @code{setenv} adds @var{name} to the environment with value diff --git a/libiberty/setproctitle.c b/libiberty/setproctitle.c index a22fb1f..3b3f377 100644 --- a/libiberty/setproctitle.c +++ b/libiberty/setproctitle.c @@ -1,5 +1,5 @@ /* 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. Libiberty is free software; you can redistribute it and/or @@ -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, but defined for compatibility with BSD. diff --git a/libiberty/simple-object.txh b/libiberty/simple-object.txh index 907233a..34639f1 100644 --- a/libiberty/simple-object.txh +++ b/libiberty/simple-object.txh @@ -1,5 +1,7 @@ @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 @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. @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}. 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. @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 information for the first section with that name. @@ -63,14 +70,16 @@ relevant errno. @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 not close the file descriptor. @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 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 @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 together without error, return @code{NULL}. Otherwise, return an @@ -93,13 +104,16 @@ if there is no relevant errno. @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}. @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 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. @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 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 @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 @var{simple_object}. If @var{copy} is non-zero, the data will be @@ -148,7 +167,8 @@ no relevant erro. @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 descriptor. This writes out all the data accumulated by calls to @@ -161,7 +181,8 @@ there is no relevant errno. @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}. diff --git a/libiberty/snprintf.c b/libiberty/snprintf.c index 36c8e9b..1e3b038 100644 --- a/libiberty/snprintf.c +++ b/libiberty/snprintf.c @@ -1,5 +1,5 @@ /* 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>. 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. */ /* -@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 @var{buf} at most @code{@var{n}-1} bytes of text, followed by a diff --git a/libiberty/splay-tree.c b/libiberty/splay-tree.c index 27ae466..12bfa8b 100644 --- a/libiberty/splay-tree.c +++ b/libiberty/splay-tree.c @@ -1,6 +1,6 @@ /* A splay-tree datatype. 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). This file is part of GNU CC. @@ -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 -(splay_tree_compare_fn @var{compare_fn}, -splay_tree_delete_key_fn @var{delete_key_fn}, -splay_tree_delete_value_fn @var{delete_value_fn}, -splay_tree_allocate_fn @var{tree_allocate_fn}, -splay_tree_allocate_fn @var{node_allocate_fn}, -splay_tree_deallocate_fn @var{deallocate_fn}, +@deftypefn Supplemental splay_tree splay_tree_new_with_typed_alloc @ +(splay_tree_compare_fn @var{compare_fn}, @ +splay_tree_delete_key_fn @var{delete_key_fn}, @ +splay_tree_delete_value_fn @var{delete_value_fn}, @ +splay_tree_allocate_fn @var{tree_allocate_fn}, @ +splay_tree_allocate_fn @var{node_allocate_fn}, @ +splay_tree_deallocate_fn @var{deallocate_fn}, @ void * @var{allocate_data}) This function creates a splay tree that uses two different allocators diff --git a/libiberty/stpncpy.c b/libiberty/stpncpy.c index f97206a..83d54e6 100644 --- a/libiberty/stpncpy.c +++ b/libiberty/stpncpy.c @@ -1,5 +1,5 @@ /* 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>. This file is part of the libiberty library. @@ -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} and padding with zeros if necessary. If @var{len} < strlen(@var{src}) diff --git a/libiberty/strncmp.c b/libiberty/strncmp.c index 916c2f0..23f6df6 100644 --- a/libiberty/strncmp.c +++ b/libiberty/strncmp.c @@ -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 @code{strcmp}. diff --git a/libiberty/strtod.c b/libiberty/strtod.c index adbc33b..e4da211 100644 --- a/libiberty/strtod.c +++ b/libiberty/strtod.c @@ -1,5 +1,5 @@ /* 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 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. */ /* -@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 @code{double}. If @var{endptr} is not @code{NULL}, a pointer to the diff --git a/libiberty/strtol.c b/libiberty/strtol.c index acc7882..bde5647 100644 --- a/libiberty/strtol.c +++ b/libiberty/strtol.c @@ -30,8 +30,10 @@ /* -@deftypefn Supplemental {long int} strtol (const char *@var{string}, char **@var{endptr}, int @var{base}) -@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, char **@var{endptr}, int @var{base}) +@deftypefn Supplemental {long int} strtol (const char *@var{string}, @ + 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 long integer value according to the given @var{base}, which must be diff --git a/libiberty/vasprintf.c b/libiberty/vasprintf.c index b6cb94e..85de542 100644 --- a/libiberty/vasprintf.c +++ b/libiberty/vasprintf.c @@ -1,6 +1,6 @@ /* Like vsprintf but provides a pointer to malloc'd storage, which must 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. Libiberty is free software; you can redistribute it and/or @@ -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, you pass a pointer to a pointer. This function will compute the size diff --git a/libiberty/vprintf.c b/libiberty/vprintf.c index c255316..c3193ac 100644 --- a/libiberty/vprintf.c +++ b/libiberty/vprintf.c @@ -1,8 +1,10 @@ /* @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 vsprintf (char *@var{str}, 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 vsprintf (char *@var{str}, @ + const char *@var{format}, va_list @var{ap}) These functions are the same as @code{printf}, @code{fprintf}, and @code{sprintf}, respectively, except that they are called with a diff --git a/libiberty/vsnprintf.c b/libiberty/vsnprintf.c index 5470df2..6c0afa6 100644 --- a/libiberty/vsnprintf.c +++ b/libiberty/vsnprintf.c @@ -1,5 +1,5 @@ /* 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>. 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. */ /* -@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 @var{buf} at most @code{@var{n}-1} bytes of text, followed by a diff --git a/libiberty/xmemdup.c b/libiberty/xmemdup.c index d483116..aa56f0b 100644 --- a/libiberty/xmemdup.c +++ b/libiberty/xmemdup.c @@ -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 are allocated, then @var{copy_size} bytes from @var{input} are copied into |