Skip to content

Commit

Permalink
libiberty: documentation markup and order fixes.
Browse files Browse the repository at this point in the history
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.

git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@169783 138bc75d-0d04-0410-961f-82ee72b054a4
  • Loading branch information
rwild committed Feb 3, 2011
1 parent 1f86411 commit bac427a
Show file tree
Hide file tree
Showing 33 changed files with 366 additions and 208 deletions.
15 changes: 15 additions & 0 deletions libiberty/ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
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.
Expand Down
4 changes: 3 additions & 1 deletion libiberty/bsearch.c
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
8 changes: 5 additions & 3 deletions libiberty/concat.c
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions libiberty/crc32.c
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion libiberty/fnmatch.txh
Original file line number Diff line number Diff line change
@@ -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
Expand Down
11 changes: 7 additions & 4 deletions libiberty/fopen_unlocked.c
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Loading

0 comments on commit bac427a

Please sign in to comment.