Skip to content

Commit 996c0cb

Browse files
Ralf WildenhuesRalf Wildenhues
Ralf Wildenhues
authored and
Ralf Wildenhues
committed
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
1 parent 4deef53 commit 996c0cb

33 files changed

+366
-208
lines changed

libiberty/ChangeLog

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
2011-02-03 Ralf Wildenhues <[email protected]>
2+
3+
* splay-tree.c: Escape wrapping newlines in texinfo markup
4+
with '@', to fix function declaration output rendering.
5+
* gather-docs: Relax and improve macro name matching to actually
6+
match all current names and to allow input line wrapping.
7+
* bsearch.c, concat.c, crc32.c, fnmatch.txh, fopen_unlocked.c,
8+
hashtab.c, insque.c, make-relative-prefix.c, memchr.c, memcmp.c,
9+
memcpy.c, memmem.c, memmove.c, mempcpy.c, memset.c,
10+
pexecute.txh, random.c, setenv.c, setproctitle.c,
11+
simple-object.txh, snprintf.c, stpncpy.c, strncmp.c, strtod.c,
12+
strtol.c, vasprintf.c, vprintf.c, vsnprintf.c, xmemdup.c:
13+
Wrap long texinfo input lines.
14+
* functions.texi: Regenerate.
15+
116
2011-01-18 Mike Frysinger <[email protected]>
217

318
* .gitignore: New file.

libiberty/bsearch.c

+3-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@
3030

3131
/*
3232
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 *))
33+
@deftypefn Supplemental void* bsearch (const void *@var{key}, @
34+
const void *@var{base}, size_t @var{nmemb}, size_t @var{size}, @
35+
int (*@var{compar})(const void *, const void *))
3436
3537
Performs a search over an array of @var{nmemb} elements pointed to by
3638
@var{base} for a member that matches the object pointed to by @var{key}.

libiberty/concat.c

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* Concatenate variable number of strings.
2-
Copyright (C) 1991, 1994, 2001 Free Software Foundation, Inc.
2+
Copyright (C) 1991, 1994, 2001, 2011 Free Software Foundation, Inc.
33
Written by Fred Fish @ Cygnus Support
44
55
This file is part of the libiberty library.
@@ -21,7 +21,8 @@ Boston, MA 02110-1301, USA. */
2121

2222
/*
2323
24-
@deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @dots{}, @code{NULL})
24+
@deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @
25+
@dots{}, @code{NULL})
2526
2627
Concatenate zero or more of strings and return the result in freshly
2728
@code{xmalloc}ed memory. Returns @code{NULL} if insufficient memory is
@@ -170,7 +171,8 @@ concat (const char *first, ...)
170171

171172
/*
172173
173-
@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @dots{}, @code{NULL})
174+
@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @
175+
@dots{}, @code{NULL})
174176
175177
Same as @code{concat}, except that if @var{optr} is not @code{NULL} it
176178
is freed after the string is created. This is intended to be useful

libiberty/crc32.c

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* crc32.c
2-
Copyright (C) 2009 Free Software Foundation, Inc.
2+
Copyright (C) 2009, 2011 Free Software Foundation, Inc.
33
44
This file is part of the libiberty library.
55
@@ -138,7 +138,8 @@ static const unsigned int crc32_table[] =
138138

139139
/*
140140
141-
@deftypefn Extension unsigned int crc32 (const unsigned char *@var{buf}, int @var{len}, unsigned int @var{init})
141+
@deftypefn Extension {unsigned int} crc32 (const unsigned char *@var{buf}, @
142+
int @var{len}, unsigned int @var{init})
142143
143144
Compute the 32-bit CRC of @var{buf} which has length @var{len}. The
144145
starting value is @var{init}; this may be used to compute the CRC of

libiberty/fnmatch.txh

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
@deftypefn Replacement int fnmatch (const char *@var{pattern}, const char *@var{string}, int @var{flags})
1+
@deftypefn Replacement int fnmatch (const char *@var{pattern}, @
2+
const char *@var{string}, int @var{flags})
23

34
Matches @var{string} against @var{pattern}, returning zero if it
45
matches, @code{FNM_NOMATCH} if not. @var{pattern} may contain the

libiberty/fopen_unlocked.c

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* Implement fopen_unlocked and related functions.
2-
Copyright (C) 2005 Free Software Foundation, Inc.
2+
Copyright (C) 2005, 2011 Free Software Foundation, Inc.
33
Written by Kaveh R. Ghazi <[email protected]>.
44
55
This file is part of the libiberty library.
@@ -36,7 +36,8 @@ multi-threaded locking. Otherwise do nothing.
3636
3737
@end deftypefn
3838
39-
@deftypefn Extension {FILE *} fopen_unlocked (const char *@var{path}, const char * @var{mode})
39+
@deftypefn Extension {FILE *} fopen_unlocked (const char *@var{path}, @
40+
const char * @var{mode})
4041
4142
Opens and returns a @code{FILE} pointer via @code{fopen}. If the
4243
operating system supports it, ensure that the stream is setup to avoid
@@ -45,7 +46,8 @@ unchanged.
4546
4647
@end deftypefn
4748
48-
@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, const char * @var{mode})
49+
@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, @
50+
const char * @var{mode})
4951
5052
Opens and returns a @code{FILE} pointer via @code{fdopen}. If the
5153
operating system supports it, ensure that the stream is setup to avoid
@@ -54,7 +56,8 @@ unchanged.
5456
5557
@end deftypefn
5658
57-
@deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, const char * @var{mode}, FILE * @var{stream})
59+
@deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, @
60+
const char * @var{mode}, FILE * @var{stream})
5861
5962
Opens and returns a @code{FILE} pointer via @code{freopen}. If the
6063
operating system supports it, ensure that the stream is setup to avoid

0 commit comments

Comments
 (0)