diff options
| author | Jeff Johnston <jjohnstn@redhat.com> | 2005-10-29 01:21:08 +0400 |
|---|---|---|
| committer | Jeff Johnston <jjohnstn@redhat.com> | 2005-10-29 01:21:08 +0400 |
| commit | 239c2bf93e32e147dab3e6cde99078d1ad5a1ef5 (patch) | |
| tree | ce34a06bc2f7aa30c01d990662463072df296bc6 | |
| parent | 39e9e2b0c972dee5cbcb1a0c10c175805c647e51 (diff) | |
2005-10-28 Bob Wilson <bob.wilson@acm.org>
* libc/misc/unctrl.c: Replace FUNCTION description.
* libc/signal/signal.c: Remove documentation for raise and _raise_r.
* libc/stdio/getdelim.c: Fix spelling errors.
* libc/stdio/getw.c: Put RETURNS on a separate line. Fix punctuation.
* libc/stdio/putw.c: Likewise.
* libc/stdlib/a64l.c: Fix formatting, spelling and punctuation in
documentation.
* libc/stdlib/assert.c: Do not capitalize FUNCTION description.
* libc/stdlib/efgcvt.c: Add spaces to FUNCTION description.
* libc/stdlib/envlock.c: Use em-dash in FUNCTION description.
* libc/stdlib/mlock.c: Likewise.
* libc/stdlib/mstats.c: Likewise.
* libc/time/tzlock.c: Likewise.
* libc/stdlib/rand.c: Use "multi-threaded" and "thread-safe" in NOTES.
* libc/stdlib/rand48.c: Remove extra space in FUNCTION description
and hyphenate "pseudo-random".
* libc/string/bcmp.c: Remove extra blank lines in documentation.
* libc/string/strncat.c: Likewise.
* libc/string/memchr.c: Remove extra ">" character in documentation.
* libc/string/strcspn.c: Use "characters" instead of "chars".
* libc/string/strpbrk.c: Likewise.
* libc/string/strerror_r.c: Capitalize "GNU".
* libc/string/strnlen.c: Likewise.
* libc/string/strtok.c: Fix formatting, spelling and punctuation in
documentation. Use "multi-threaded" and "thread-safe" in NOTES.
* libc/string/wcscat.c: Split PORTABILITY into two paragraphs.
* libc/string/wcschr.c: Likewise.
* libc/string/wcscmp.c: Likewise.
* libc/string/wcscpy.c: Likewise.
* libc/string/wcscspn.c: Likewise.
* libc/string/wcslen.c: Likewise.
* libc/string/wcsncat.c: Likewise.
* libc/string/wcsncmp.c: Likewise.
* libc/string/wcsncpy.c: Likewise.
* libc/string/wcsnlen.c: Likewise.
* libc/string/wcspbrk.c: Likewise.
* libc/string/wcsrchr.c: Likewise.
* libc/string/wcsspn.c: Likewise.
* libc/string/wmemchr.c: Likewise.
* libc/string/wmemcmp.c: Likewise.
* libc/string/wmemcpy.c: Likewise.
* libc/string/wmemset.c: Likewise.
* libc/string/wmemmove.c: Likewise. Also fix FUNCTION description.
* libc/string/wcswidth.c: Formatting and punctuation in documentation.
* libc/string/wcwidth.c: Likewise.
* libm/common/s_modf.c: Remove extra period from documentation.
* libm/math/s_isnan.c: Fix formatting, grammar and punctuation in
documentation.
* libm/mathfp/s_isnan.c: Likewise.
* libm/math/s_ldexp.c: Fix punctuation.
* libm/mathfp/s_ldexp.c: Likewise.
* libm/math/w_log.c: Likewise.
* libm/mathfp/s_logarithm.c: Likewise.
* libm/math/w_j0.c: Add spaces to FUNCTION description.
* libm/mathfp/w_jn.c: Likewise.
52 files changed, 192 insertions, 132 deletions
diff --git a/newlib/ChangeLog b/newlib/ChangeLog index 2a897d1d3..7bae151d5 100644 --- a/newlib/ChangeLog +++ b/newlib/ChangeLog @@ -1,3 +1,61 @@ +2005-10-28 Bob Wilson <bob.wilson@acm.org> + + * libc/misc/unctrl.c: Replace FUNCTION description. + * libc/signal/signal.c: Remove documentation for raise and _raise_r. + * libc/stdio/getdelim.c: Fix spelling errors. + * libc/stdio/getw.c: Put RETURNS on a separate line. Fix punctuation. + * libc/stdio/putw.c: Likewise. + * libc/stdlib/a64l.c: Fix formatting, spelling and punctuation in + documentation. + * libc/stdlib/assert.c: Do not capitalize FUNCTION description. + * libc/stdlib/efgcvt.c: Add spaces to FUNCTION description. + * libc/stdlib/envlock.c: Use em-dash in FUNCTION description. + * libc/stdlib/mlock.c: Likewise. + * libc/stdlib/mstats.c: Likewise. + * libc/time/tzlock.c: Likewise. + * libc/stdlib/rand.c: Use "multi-threaded" and "thread-safe" in NOTES. + * libc/stdlib/rand48.c: Remove extra space in FUNCTION description + and hyphenate "pseudo-random". + * libc/string/bcmp.c: Remove extra blank lines in documentation. + * libc/string/strncat.c: Likewise. + * libc/string/memchr.c: Remove extra ">" character in documentation. + * libc/string/strcspn.c: Use "characters" instead of "chars". + * libc/string/strpbrk.c: Likewise. + * libc/string/strerror_r.c: Capitalize "GNU". + * libc/string/strnlen.c: Likewise. + * libc/string/strtok.c: Fix formatting, spelling and punctuation in + documentation. Use "multi-threaded" and "thread-safe" in NOTES. + * libc/string/wcscat.c: Split PORTABILITY into two paragraphs. + * libc/string/wcschr.c: Likewise. + * libc/string/wcscmp.c: Likewise. + * libc/string/wcscpy.c: Likewise. + * libc/string/wcscspn.c: Likewise. + * libc/string/wcslen.c: Likewise. + * libc/string/wcsncat.c: Likewise. + * libc/string/wcsncmp.c: Likewise. + * libc/string/wcsncpy.c: Likewise. + * libc/string/wcsnlen.c: Likewise. + * libc/string/wcspbrk.c: Likewise. + * libc/string/wcsrchr.c: Likewise. + * libc/string/wcsspn.c: Likewise. + * libc/string/wmemchr.c: Likewise. + * libc/string/wmemcmp.c: Likewise. + * libc/string/wmemcpy.c: Likewise. + * libc/string/wmemset.c: Likewise. + * libc/string/wmemmove.c: Likewise. Also fix FUNCTION description. + * libc/string/wcswidth.c: Formatting and punctuation in documentation. + * libc/string/wcwidth.c: Likewise. + * libm/common/s_modf.c: Remove extra period from documentation. + * libm/math/s_isnan.c: Fix formatting, grammar and punctuation in + documentation. + * libm/mathfp/s_isnan.c: Likewise. + * libm/math/s_ldexp.c: Fix punctuation. + * libm/mathfp/s_ldexp.c: Likewise. + * libm/math/w_log.c: Likewise. + * libm/mathfp/s_logarithm.c: Likewise. + * libm/math/w_j0.c: Add spaces to FUNCTION description. + * libm/mathfp/w_jn.c: Likewise. + 2005-10-26 Shaun Jackman <sjackman@gmail.com> * libc/posix/scandir.c (scandir): Update the function diff --git a/newlib/libc/misc/unctrl.c b/newlib/libc/misc/unctrl.c index 710bf16bd..fa0b90ff1 100644 --- a/newlib/libc/misc/unctrl.c +++ b/newlib/libc/misc/unctrl.c @@ -1,6 +1,6 @@ /* FUNCTION - <<unctrl>>---translate characters to upper case + <<unctrl>>---get printable representation of a character INDEX unctrl diff --git a/newlib/libc/signal/signal.c b/newlib/libc/signal/signal.c index 20e919e74..bfb85e66a 100644 --- a/newlib/libc/signal/signal.c +++ b/newlib/libc/signal/signal.c @@ -6,21 +6,12 @@ INDEX signal INDEX _signal_r -INDEX - raise -INDEX - _raise_r ANSI_SYNOPSIS #include <signal.h> - void ( * signal(int <[sig]>, void(*<[func]>)(int)) )(int); - - void ( * _signal_r(void *<[reent]>, - int <[sig]>, void(*<[func]>)(int)) )(int); + void (*signal(int <[sig]>, void(*<[func]>)(int))) (int); - int raise (int <[sig]>); - - int _raise_r (void *<[reent]>, int <[sig]>); + void (*_signal_r(void *<[reent]>, int <[sig]>, void(*<[func]>)(int))) (int); TRAD_SYNOPSIS #include <signal.h> @@ -33,15 +24,8 @@ TRAD_SYNOPSIS int <[sig]>; char ( * <[func]> )(); - int raise (<[sig]>)() - int <[sig]>; - - int _raise_r (<[reent]>, <[sig]>)() - char *<[reent]>; - int <[sig]>; - DESCRIPTION -<<signal, raise>> provide a simple signal/raise implementation for embedded +<<signal>> provides a simple signal-handling implementation for embedded targets. <<signal>> allows you to request changed treatment for a particular @@ -52,7 +36,7 @@ that identifies a subroutine in your program as the handler for this signal. Some of the execution environment for signal handlers is unpredictable; notably, the only library function required to work -correctly from within a signal handler is @code{signal} itself, and +correctly from within a signal handler is <<signal>> itself, and only when used to redefine the handler for the current signal value. Static storage is likewise unreliable for signal handlers, with one @@ -66,13 +50,9 @@ where it was when the signal was raised (whether by your program itself, or by an external event). Signal handlers can also use functions such as <<exit>> and <<abort>> to avoid returning. -<<raise>> sends the signal sig to the executing program. It returns zero if -successful, non-zero if unsuccessful. - -The alternate functions <<_signal_r, _raise_r>> are the reentrant versions. +The alternate function <<_signal_r>> is the reentrant version. The extra argument <[reent]> is a pointer to a reentrancy structure. - @c FIXME: do we have setjmp.h and assoc fns? RETURNS @@ -83,7 +63,7 @@ Otherwise, the result is the previous handler (a function pointer or one of the predefined macros). PORTABILITY -ANSI C requires <<raise>>, <<signal>>. +ANSI C requires <<signal>>. No supporting OS subroutines are required to link with <<signal>>, but it will not have any useful effects, except for software generated signals, diff --git a/newlib/libc/stdio/getdelim.c b/newlib/libc/stdio/getdelim.c index dad8feeb2..0fdfb3add 100644 --- a/newlib/libc/stdio/getdelim.c +++ b/newlib/libc/stdio/getdelim.c @@ -1,7 +1,7 @@ /* Copyright 2002, Red Hat Inc. - all rights reserved */ /* FUNCTION -<<getdelim>>---read a line up to a specified line delimeter +<<getdelim>>---read a line up to a specified line delimiter INDEX getdelim @@ -21,16 +21,16 @@ TRAD_SYNOPSIS DESCRIPTION <<getdelim>> reads a file <[fp]> up to and possibly including a specified -delimeter <[delim]>. The line is read into a buffer pointed to +delimiter <[delim]>. The line is read into a buffer pointed to by <[bufptr]> and designated with size *<[n]>. If the buffer is not large enough, it will be dynamically grown by <<getdelim>>. As the buffer is grown, the pointer to the size <[n]> will be updated. RETURNS -<<getdelim>> returns <<-1>> if no characters were successfully read, +<<getdelim>> returns <<-1>> if no characters were successfully read; otherwise, it returns the number of bytes successfully read. -at end of file, the result is nonzero. +At end of file, the result is nonzero. PORTABILITY <<getdelim>> is a glibc extension. diff --git a/newlib/libc/stdio/getw.c b/newlib/libc/stdio/getw.c index b5065bd53..210c5939a 100644 --- a/newlib/libc/stdio/getw.c +++ b/newlib/libc/stdio/getw.c @@ -37,14 +37,15 @@ to get the next word from the file or stream identified by <[fp]>. As a side effect, <<getw>> advances the file's current position indicator. -RETURNS The next word (read as an <<int>>), unless there is no more -data, or the host system reports a read error; in either of these +RETURNS +The next word (read as an <<int>>), unless there is no more +data or the host system reports a read error; in either of these situations, <<getw>> returns <<EOF>>. Since <<EOF>> is a valid <<int>>, you must use <<ferror>> or <<feof>> to distinguish these situations. PORTABILITY -<<getw>> is a remnant of K&R C, it is not part of any ISO C Standard. +<<getw>> is a remnant of K&R C; it is not part of any ISO C Standard. <<fread>> should be used instead. In fact, this implementation of <<getw>> is based upon <<fread>>. diff --git a/newlib/libc/stdio/putw.c b/newlib/libc/stdio/putw.c index 78406eeb4..682015c0a 100644 --- a/newlib/libc/stdio/putw.c +++ b/newlib/libc/stdio/putw.c @@ -37,10 +37,11 @@ DESCRIPTION to write a word to the file or stream identified by <[fp]>. As a side effect, <<putw>> advances the file's current position indicator. -RETURNS Zero on success, <<EOF>> on failure. +RETURNS +Zero on success, <<EOF>> on failure. PORTABILITY -<<putw>> is a remnant of K&R C, it is not part of any ISO C Standard. +<<putw>> is a remnant of K&R C; it is not part of any ISO C Standard. <<fwrite>> should be used instead. In fact, this implementation of <<putw>> is based upon <<fwrite>>. diff --git a/newlib/libc/stdlib/a64l.c b/newlib/libc/stdlib/a64l.c index 93c8e834b..42fc2d2fa 100644 --- a/newlib/libc/stdlib/a64l.c +++ b/newlib/libc/stdlib/a64l.c @@ -1,6 +1,6 @@ /* FUNCTION -<<a64l>>,<<l64a>>---convert between radix-64 ascii string and long +<<a64l>>, <<l64a>>---convert between radix-64 ASCII string and long INDEX a64l @@ -21,31 +21,36 @@ TRAD_SYNOPSIS long <[input]>; DESCRIPTION -Conversion is performed between long and radix-64 characters. The <<l64a>> routine -transforms up to 32-bits of input value starting from least significant bits to -the most significant bits. The input value is split up into a maximum of 5 -groups of 6-bits and possibly one group of 2 bits (bits 31 and 30). - -Each group of 6 bits forms a value from 0-63 which is translated into a character -as follows: - - 0 = '.' - 1 = '/' - 2-11 = '0' to '9' - 12-37 = 'A' to 'Z' - 38-63 = 'a' to 'z' - -When remaining bits are zero or all bits have been translated, a nul terminator -is appended to the string. An input value of 0 results in the empty string. - -The <<a64l>> performs the reverse translation. Each character is used to generate -a 6-bit value for up to 30 bits and then a 2-bit value to complete a 32-bit result. -The nul terminator means that the remaining digits are 0. An empty input string or -NULL string results in 0L. An invalid string results in undefined behavior. -If the size of a long is > 32 bits, the result is sign-extended. - +Conversion is performed between long and radix-64 characters. The +<<l64a>> routine transforms up to 32 bits of input value starting from +least significant bits to the most significant bits. The input value +is split up into a maximum of 5 groups of 6 bits and possibly one +group of 2 bits (bits 31 and 30). + +Each group of 6 bits forms a value from 0--63 which is translated into +a character as follows: + +O+ +o 0 = '.' +o 1 = '/' +o 2--11 = '0' to '9' +o 12--37 = 'A' to 'Z' +o 38--63 = 'a' to 'z' +O- + +When the remaining bits are zero or all bits have been translated, a +null terminator is appended to the string. An input value of 0 +results in the empty string. + +The <<a64l>> function performs the reverse translation. Each +character is used to generate a 6-bit value for up to 30 bits and then +a 2-bit value to complete a 32-bit result. The null terminator means +that the remaining digits are 0. An empty input string or NULL string +results in 0L. An invalid string results in undefined behavior. If +the size of a long is greater than 32 bits, the result is sign-extended. + RETURNS -<<l64a>> returns a nul-terminated string of 0 to 6 characters. +<<l64a>> returns a null-terminated string of 0 to 6 characters. <<a64l>> returns the 32-bit translated value from the input character string. PORTABILITY diff --git a/newlib/libc/stdlib/assert.c b/newlib/libc/stdlib/assert.c index 5b08bbaf4..c9887da5c 100644 --- a/newlib/libc/stdlib/assert.c +++ b/newlib/libc/stdlib/assert.c @@ -1,6 +1,6 @@ /* FUNCTION -<<assert>>---Macro for Debugging Diagnostics +<<assert>>---macro for debugging diagnostics INDEX assert diff --git a/newlib/libc/stdlib/efgcvt.c b/newlib/libc/stdlib/efgcvt.c index 556d22414..9aa3b2fe7 100644 --- a/newlib/libc/stdlib/efgcvt.c +++ b/newlib/libc/stdlib/efgcvt.c @@ -1,6 +1,6 @@ /* FUNCTION -<<ecvt>>,<<ecvtf>>,<<fcvt>>,<<fcvtf>>---double or float to string +<<ecvt>>, <<ecvtf>>, <<fcvt>>, <<fcvtf>>---double or float to string INDEX ecvt diff --git a/newlib/libc/stdlib/envlock.c b/newlib/libc/stdlib/envlock.c index 24d0083be..74c85a8f5 100644 --- a/newlib/libc/stdlib/envlock.c +++ b/newlib/libc/stdlib/envlock.c @@ -1,6 +1,6 @@ /* FUNCTION -<<__env_lock>>, <<__env_unlock>>--lock environ variable +<<__env_lock>>, <<__env_unlock>>---lock environ variable INDEX __env_lock diff --git a/newlib/libc/stdlib/mlock.c b/newlib/libc/stdlib/mlock.c index 378b4e691..888c986a9 100644 --- a/newlib/libc/stdlib/mlock.c +++ b/newlib/libc/stdlib/mlock.c @@ -1,7 +1,7 @@ #ifndef MALLOC_PROVIDED /* FUNCTION -<<__malloc_lock>>, <<__malloc_unlock>>--lock malloc pool +<<__malloc_lock>>, <<__malloc_unlock>>---lock malloc pool INDEX __malloc_lock diff --git a/newlib/libc/stdlib/mstats.c b/newlib/libc/stdlib/mstats.c index 42b5db2fe..ba89f494d 100644 --- a/newlib/libc/stdlib/mstats.c +++ b/newlib/libc/stdlib/mstats.c @@ -10,7 +10,7 @@ int _dummy_mstats = 1; /* FUNCTION -<<mallinfo>>, <<malloc_stats>>, <<mallopt>>--malloc support +<<mallinfo>>, <<malloc_stats>>, <<mallopt>>---malloc support INDEX mallinfo diff --git a/newlib/libc/stdlib/rand.c b/newlib/libc/stdlib/rand.c index 4f5a60796..6a46aa807 100644 --- a/newlib/libc/stdlib/rand.c +++ b/newlib/libc/stdlib/rand.c @@ -51,8 +51,8 @@ number between <<0>> and <<RAND_MAX>> (inclusive). <<srand>> does not return a result. NOTES -<<rand>> and <<srand>> are unsafe for multi-thread applications. -<<rand_r>> is MT-Safe and should be used instead. +<<rand>> and <<srand>> are unsafe for multi-threaded applications. +<<rand_r>> is thread-safe and should be used instead. PORTABILITY diff --git a/newlib/libc/stdlib/rand48.c b/newlib/libc/stdlib/rand48.c index 17fd04e92..af2be3c07 100644 --- a/newlib/libc/stdlib/rand48.c +++ b/newlib/libc/stdlib/rand48.c @@ -13,7 +13,7 @@ /* FUNCTION - <<rand48>>, <<drand48>>, <<erand48>>, <<lrand48>>, <<nrand48>>, <<mrand48>>, <<jrand48>>, <<srand48>>, <<seed48>>, <<lcong48>> ---pseudo random number generators and initialization routines + <<rand48>>, <<drand48>>, <<erand48>>, <<lrand48>>, <<nrand48>>, <<mrand48>>, <<jrand48>>, <<srand48>>, <<seed48>>, <<lcong48>>---pseudo-random number generators and initialization routines INDEX rand48 diff --git a/newlib/libc/string/bcmp.c b/newlib/libc/string/bcmp.c index 23e7c26a2..e8d057352 100644 --- a/newlib/libc/string/bcmp.c +++ b/newlib/libc/string/bcmp.c @@ -21,8 +21,6 @@ DESCRIPTION object pointed to by <[s1]> with the object pointed to by <[s2]>. This function is identical to <<memcmp>>. - - RETURNS The function returns an integer greater than, equal to or diff --git a/newlib/libc/string/memchr.c b/newlib/libc/string/memchr.c index 2fd3c861d..7c1a584b7 100644 --- a/newlib/libc/string/memchr.c +++ b/newlib/libc/string/memchr.c @@ -28,9 +28,9 @@ RETURNS <[c]> is not found, then <<NULL>> is returned. PORTABILITY -<<memchr>>> is ANSI C. +<<memchr>> is ANSI C. -<<memchr>> requires no supporting OS subroutines. +<<memchr>> requires no supporting OS subroutines. QUICKREF memchr ansi pure diff --git a/newlib/libc/string/strcspn.c b/newlib/libc/string/strcspn.c index fe68b8f51..403330c94 100644 --- a/newlib/libc/string/strcspn.c +++ b/newlib/libc/string/strcspn.c @@ -1,6 +1,6 @@ /* FUNCTION - <<strcspn>>---count chars not in string + <<strcspn>>---count characters not in string INDEX strcspn diff --git a/newlib/libc/string/strerror_r.c b/newlib/libc/string/strerror_r.c index 956a1f485..be5358f3e 100644 --- a/newlib/libc/string/strerror_r.c +++ b/newlib/libc/string/strerror_r.c @@ -30,7 +30,7 @@ This function returns a pointer to a string. Your application must not modify that string. PORTABILITY -<<strerror_r>> is a gnu extension. +<<strerror_r>> is a GNU extension. <<strerror_r>> requires no supporting OS subroutines. diff --git a/newlib/libc/string/strncat.c b/newlib/libc/string/strncat.c index 57ca068eb..0f29247a8 100644 --- a/newlib/libc/string/strncat.c +++ b/newlib/libc/string/strncat.c @@ -28,7 +28,6 @@ WARNINGS Note that a null is always appended, so that if the copy is limited by the <[length]> argument, the number of characters appended to <[dst]> is <<n + 1>>. - RETURNS This function returns the initial value of <[dst]> diff --git a/newlib/libc/string/strnlen.c b/newlib/libc/string/strnlen.c index b9a3b5e77..92826eeb2 100644 --- a/newlib/libc/string/strnlen.c +++ b/newlib/libc/string/strnlen.c @@ -25,7 +25,7 @@ RETURNS <<strnlen>> returns the character count or <[n]>. PORTABILITY -<<strnlen>> is a Gnu extension. +<<strnlen>> is a GNU extension. <<strnlen>> requires no supporting OS subroutines. diff --git a/newlib/libc/string/strpbrk.c b/newlib/libc/string/strpbrk.c index e7f2dd2b6..5668db395 100644 --- a/newlib/libc/string/strpbrk.c +++ b/newlib/libc/string/strpbrk.c @@ -1,6 +1,6 @@ /* FUNCTION - <<strpbrk>>---find chars in string + <<strpbrk>>---find characters in string INDEX strpbrk diff --git a/newlib/libc/string/strtok.c b/newlib/libc/string/strtok.c index 8d53290c7..7640fb73d 100644 --- a/newlib/libc/string/strtok.c +++ b/newlib/libc/string/strtok.c @@ -1,6 +1,6 @@ /* FUNCTION - <<strtok>>,<<strtok_r>>,<<strsep>>---get next token from a string + <<strtok>>, <<strtok_r>>, <<strsep>>---get next token from a string INDEX strtok @@ -40,25 +40,25 @@ DESCRIPTION The first time that <<strtok>> is called, <<*<[source]>>> should be specified; subsequent calls, wishing to obtain further tokens from the same string, should pass a null pointer instead. The separator - string, <<*<[delimiters]>>>, must be supplied each time, and may + string, <<*<[delimiters]>>>, must be supplied each time and may change between calls. The <<strtok>> function returns a pointer to the beginning of each subsequent token in the string, after replacing the separator - character itself with a NUL character. When no more tokens remain, + character itself with a null character. When no more tokens remain, a null pointer is returned. The <<strtok_r>> function has the same behavior as <<strtok>>, except - a pointer to placeholder <<*[lasts]>> must be supplied by the caller. + a pointer to placeholder <<*<[lasts]>>> must be supplied by the caller. The <<strsep>> function is similar in behavior to <<strtok>>, except - a pointer to the string pointer must be supplied <<[source_ptr]>> and - the function does not skip leading delimeters. When the string starts - with a delimeter, the delimeter is changed to the NUL character and + a pointer to the string pointer must be supplied <<<[source_ptr]>>> and + the function does not skip leading delimiters. When the string starts + with a delimiter, the delimiter is changed to the null character and the empty string is returned. Like <<strtok_r>> and <<strtok>>, the - <<*[source_ptr]>> is updated to the next character following the - last delimeter found or NULL if the end of string is reached with - no more delimeters. + <<*<[source_ptr]>>> is updated to the next character following the + last delimiter found or NULL if the end of string is reached with + no more delimiters. RETURNS <<strtok>>, <<strtok_r>>, and <<strsep>> all return a pointer to the @@ -66,13 +66,13 @@ RETURNS <<strsep>>, a token may be the empty string. NOTES - <<strtok>> is unsafe for multi-thread applications. <<strtok_r>> - and <<strsep>> are MT-Safe and should be used instead. + <<strtok>> is unsafe for multi-threaded applications. <<strtok_r>> + and <<strsep>> are thread-safe and should be used instead. PORTABILITY <<strtok>> is ANSI C. <<strtok_r>> is POSIX. -<<strsep>> is a BSD-extension. +<<strsep>> is a BSD extension. <<strtok>>, <<strtok_r>>, and <<strsep>> require no supporting OS subroutines. diff --git a/newlib/libc/string/wcscat.c b/newlib/libc/string/wcscat.c index b3a3bd987..54c0b503b 100644 --- a/newlib/libc/string/wcscat.c +++ b/newlib/libc/string/wcscat.c @@ -27,6 +27,7 @@ RETURNS PORTABILITY <<wcscat>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcschr.c b/newlib/libc/string/wcschr.c index acc07a521..fb35d1f42 100644 --- a/newlib/libc/string/wcschr.c +++ b/newlib/libc/string/wcschr.c @@ -24,6 +24,7 @@ RETURNS PORTABILITY <<wcschr>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcscmp.c b/newlib/libc/string/wcscmp.c index 279f3a90c..03089620d 100644 --- a/newlib/libc/string/wcscmp.c +++ b/newlib/libc/string/wcscmp.c @@ -26,6 +26,7 @@ RETURNS PORTABILITY <<wcscmp>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcscpy.c b/newlib/libc/string/wcscpy.c index 5a72338ce..ede693d9c 100644 --- a/newlib/libc/string/wcscpy.c +++ b/newlib/libc/string/wcscpy.c @@ -23,6 +23,7 @@ RETURNS PORTABILITY <<wcscpy>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcscspn.c b/newlib/libc/string/wcscspn.c index 7e53cc15d..5ab965690 100644 --- a/newlib/libc/string/wcscspn.c +++ b/newlib/libc/string/wcscspn.c @@ -23,6 +23,7 @@ RETURNS PORTABILITY <<wcscspn>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcslen.c b/newlib/libc/string/wcslen.c index d68f00a72..d671551af 100644 --- a/newlib/libc/string/wcslen.c +++ b/newlib/libc/string/wcslen.c @@ -21,6 +21,7 @@ RETURNS PORTABILITY <<wcslen>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcsncat.c b/newlib/libc/string/wcsncat.c index 2ba293497..fd77c0cc8 100644 --- a/newlib/libc/string/wcsncat.c +++ b/newlib/libc/string/wcsncat.c @@ -29,6 +29,7 @@ RETURNS PORTABILITY <<wcsncat>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcsncmp.c b/newlib/libc/string/wcsncmp.c index 48cb96c25..1897f5c4e 100644 --- a/newlib/libc/string/wcsncmp.c +++ b/newlib/libc/string/wcsncmp.c @@ -30,6 +30,7 @@ RETURNS PORTABILITY <<wcsncmp>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcsncpy.c b/newlib/libc/string/wcsncpy.c index afe75a238..b53e9c332 100644 --- a/newlib/libc/string/wcsncpy.c +++ b/newlib/libc/string/wcsncpy.c @@ -30,6 +30,7 @@ RETURNS PORTABILITY <<wcsncpy>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcsnlen.c b/newlib/libc/string/wcsnlen.c index e84342d3d..3804bdf90 100644 --- a/newlib/libc/string/wcsnlen.c +++ b/newlib/libc/string/wcsnlen.c @@ -27,7 +27,8 @@ RETURNS characters. PORTABILITY -<<wcsnlen>> is GNU extension.. +<<wcsnlen>> is a GNU extension. + <<wcsnlen>> requires no supporting OS subroutines. */ diff --git a/newlib/libc/string/wcspbrk.c b/newlib/libc/string/wcspbrk.c index bfe793b15..fbdf9e49c 100644 --- a/newlib/libc/string/wcspbrk.c +++ b/newlib/libc/string/wcspbrk.c @@ -23,6 +23,7 @@ RETURNS PORTABILITY <<wcspbrk>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcsrchr.c b/newlib/libc/string/wcsrchr.c index d3dc7431e..495d95a15 100644 --- a/newlib/libc/string/wcsrchr.c +++ b/newlib/libc/string/wcsrchr.c @@ -27,6 +27,7 @@ RETURNS PORTABILITY <<wcsrchr>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcsspn.c b/newlib/libc/string/wcsspn.c index b54804c45..e83f42f4f 100644 --- a/newlib/libc/string/wcsspn.c +++ b/newlib/libc/string/wcsspn.c @@ -23,6 +23,7 @@ RETURNS PORTABILITY <<wcsspn>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wcswidth.c b/newlib/libc/string/wcswidth.c index bd3d9bbad..8a9670eb1 100644 --- a/newlib/libc/string/wcswidth.c +++ b/newlib/libc/string/wcswidth.c @@ -17,22 +17,22 @@ TRAD_SYNOPSIS DESCRIPTION The <<wcswidth>> function shall determine the number of column - positions required for n wide-character codes (or fewer than n + positions required for <[n]> wide-character codes (or fewer than <[n]> wide-character codes if a null wide-character code is encountered - before n wide-character codes are exhausted) in the string pointed - to by pwcs. + before <[n]> wide-character codes are exhausted) in the string pointed + to by <[pwcs]>. RETURNS - The <<wcswidth>> function either shall return 0 (if pwcs points to a + The <<wcswidth>> function either shall return 0 (if <[pwcs]> points to a null wide-character code), or return the number of column positions - to be occupied by the wide-character string pointed to by pwcs, or - return -1 (if any of the first n wide-character codes in the - wide-character string pointed to by pwcs is not a printable + to be occupied by the wide-character string pointed to by <[pwcs]>, or + return -1 (if any of the first <[n]> wide-character codes in the + wide-character string pointed to by <[pwcs]> is not a printable wide-character code). PORTABILITY -<<wcswidth>> has been introduced in the Single UNIX Specification Volume 2 -<<wcswidth>> has been marked as extension in Single UNIX Specification Volume 3 +<<wcswidth>> has been introduced in the Single UNIX Specification Volume 2. +<<wcswidth>> has been marked as an extension in the Single UNIX Specification Volume 3. */ #include <_ansi.h> diff --git a/newlib/libc/string/wcwidth.c b/newlib/libc/string/wcwidth.c index 2cbd59e18..d886b4aca 100644 --- a/newlib/libc/string/wcwidth.c +++ b/newlib/libc/string/wcwidth.c @@ -16,15 +16,15 @@ TRAD_SYNOPSIS DESCRIPTION The <<wcwidth>> function shall determine the number of column - positions required for the wide character wc. The application - shall ensure that the value of wc is a character representable + positions required for the wide character <[wc]>. The application + shall ensure that the value of <[wc]> is a character representable as a wchar_t, and is a wide-character code corresponding to a valid character in the current locale. RETURNS - The <<wcwidth>> function shall either return 0 (if wc is a null + The <<wcwidth>> function shall either return 0 (if <[wc]> is a null wide-character code), or return the number of column positions to - be occupied by the wide-character code wc, or return -1 (if wc + be occupied by the wide-character code <[wc]>, or return -1 (if <[wc]> does not correspond to a printable wide-character code). The current implementation of <<wcwidth>> simply sets the width @@ -32,8 +32,8 @@ RETURNS tables around. PORTABILITY -<<wcwidth>> has been introduced in the Single UNIX Specification Volume 2 -<<wcwidth>> has been marked as extension in Single UNIX Specification Volume 3 +<<wcwidth>> has been introduced in the Single UNIX Specification Volume 2. +<<wcwidth>> has been marked as an extension in the Single UNIX Specification Volume 3. */ #include <_ansi.h> diff --git a/newlib/libc/string/wmemchr.c b/newlib/libc/string/wmemchr.c index e99991324..ca1427be0 100644 --- a/newlib/libc/string/wmemchr.c +++ b/newlib/libc/string/wmemchr.c @@ -30,6 +30,7 @@ RETURNS PORTABILITY <<wmemchr>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wmemcmp.c b/newlib/libc/string/wmemcmp.c index 51072942c..96c2b765c 100644 --- a/newlib/libc/string/wmemcmp.c +++ b/newlib/libc/string/wmemcmp.c @@ -30,6 +30,7 @@ RETURNS PORTABILITY <<wmemcmp>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wmemcpy.c b/newlib/libc/string/wmemcpy.c index c3a96a32d..24de8856b 100644 --- a/newlib/libc/string/wmemcpy.c +++ b/newlib/libc/string/wmemcpy.c @@ -27,6 +27,7 @@ RETURNS PORTABILITY <<wmemcpy>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wmemmove.c b/newlib/libc/string/wmemmove.c index f49e359f3..6986fde22 100644 --- a/newlib/libc/string/wmemmove.c +++ b/newlib/libc/string/wmemmove.c @@ -1,6 +1,6 @@ /* FUNCTION - <<wmemmove>>---wmemmove - copy wide-characters in memory with overlapping areas + <<wmemmove>>---copy wide characters in memory with overlapping areas ANSI_SYNOPSIS #include <wchar.h> @@ -33,6 +33,7 @@ RETURNS PORTABILITY <<wmemmove>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/string/wmemset.c b/newlib/libc/string/wmemset.c index 4e05b93b6..b426f5682 100644 --- a/newlib/libc/string/wmemset.c +++ b/newlib/libc/string/wmemset.c @@ -27,6 +27,7 @@ RETURNS PORTABILITY <<wmemset>> is ISO/IEC 9899/AMD1:1995 (ISO C). + No supporting OS subroutines are required. */ diff --git a/newlib/libc/time/tzlock.c b/newlib/libc/time/tzlock.c index f3c289620..ccfef7891 100644 --- a/newlib/libc/time/tzlock.c +++ b/newlib/libc/time/tzlock.c @@ -1,6 +1,6 @@ /* FUNCTION -<<__tz_lock>>, <<__tz_unlock>>--lock time zone global variables +<<__tz_lock>>, <<__tz_unlock>>---lock time zone global variables INDEX __tz_lock diff --git a/newlib/libm/common/s_modf.c b/newlib/libm/common/s_modf.c index 01151397d..2e9bfb125 100644 --- a/newlib/libm/common/s_modf.c +++ b/newlib/libm/common/s_modf.c @@ -41,7 +41,7 @@ DESCRIPTION storing the integer part in <<*<[ipart]>>>. No rounding whatsoever is done; the sum of the integer and fractional parts is guaranteed to be exactly equal to <[val]>. That - is, if . <[realpart]> = modf(<[val]>, &<[intpart]>); then + is, if <[realpart]> = modf(<[val]>, &<[intpart]>); then `<<<[realpart]>+<[intpart]>>>' is the same as <[val]>. <<modff>> is identical, save that it takes and returns <<float>> rather than <<double>> values. diff --git a/newlib/libm/math/s_isnan.c b/newlib/libm/math/s_isnan.c index 0338cfe47..596bd2d2a 100644 --- a/newlib/libm/math/s_isnan.c +++ b/newlib/libm/math/s_isnan.c @@ -13,7 +13,7 @@ /* FUNCTION - <<isnan>>,<<isnanf>>,<<isinf>>,<<isinff>>,<<finite>>,<<finitef>>---test for exceptional numbers + <<isnan>>, <<isnanf>>, <<isinf>>, <<isinff>>, <<finite>>, <<finitef>>---test for exceptional numbers INDEX isnan @@ -58,14 +58,14 @@ DESCRIPTION These functions provide information on the floating-point argument supplied. - There are five major number formats - + There are five major number formats: o+ o zero - a number which contains all zero bits. + A number which contains all zero bits. o subnormal - Is used to represent number with a zero exponent, but a nonzero fraction. - o normal - A number with an exponent, and a fraction + A number with a zero exponent but a nonzero fraction. + o normal + A number with an exponent and a fraction. o infinity A number with an all 1's exponent and a zero fraction. o NAN @@ -77,7 +77,7 @@ DESCRIPTION returns 1 if the argument is infinity. <<finite>> returns 1 if the argument is zero, subnormal or normal. - The <<isnanf>>, <<isinff>> and <<finitef>> perform the same + The <<isnanf>>, <<isinff>> and <<finitef>> functions perform the same operations as their <<isnan>>, <<isinf>> and <<finite>> counterparts, but on single-precision floating-point numbers. diff --git a/newlib/libm/math/s_ldexp.c b/newlib/libm/math/s_ldexp.c index e5d45633d..adc7d5d0e 100644 --- a/newlib/libm/math/s_ldexp.c +++ b/newlib/libm/math/s_ldexp.c @@ -56,7 +56,7 @@ On underflow, <<ldexp>> and <<ldexpf>> return 0.0. On overflow, <<ldexp>> returns plus or minus <<HUGE_VAL>>. PORTABILITY -<<ldexp>> is ANSI, <<ldexpf>> is an extension. +<<ldexp>> is ANSI. <<ldexpf>> is an extension. */ diff --git a/newlib/libm/math/w_j0.c b/newlib/libm/math/w_j0.c index 2bf663316..e4dde5ccb 100644 --- a/newlib/libm/math/w_j0.c +++ b/newlib/libm/math/w_j0.c @@ -13,7 +13,7 @@ /* FUNCTION -<<jN>>,<<jNf>>,<<yN>>,<<yNf>>---Bessel functions +<<jN>>, <<jNf>>, <<yN>>, <<yNf>>---Bessel functions INDEX j0 diff --git a/newlib/libm/math/w_log.c b/newlib/libm/math/w_log.c index dcc8b9762..3e750ad85 100644 --- a/newlib/libm/math/w_log.c +++ b/newlib/libm/math/w_log.c @@ -49,7 +49,7 @@ When <[x]> is negative, the returned value is <<-HUGE_VAL>> and <<matherr>>. PORTABILITY -<<log>> is ANSI, <<logf>> is an extension. +<<log>> is ANSI. <<logf>> is an extension. */ /* diff --git a/newlib/libm/mathfp/s_isnan.c b/newlib/libm/mathfp/s_isnan.c index 03cfeee59..70ac704c3 100644 --- a/newlib/libm/mathfp/s_isnan.c +++ b/newlib/libm/mathfp/s_isnan.c @@ -3,7 +3,7 @@ /* FUNCTION - <<isnan>>,<<isnanf>>,<<isinf>>,<<isinff>>,<<finite>>,<<finitef>>---test + <<isnan>>, <<isnanf>>, <<isinf>>, <<isinff>>, <<finite>>, <<finitef>>---test for exceptional numbers INDEX @@ -49,15 +49,14 @@ DESCRIPTION These functions provide information on the floating-point argument supplied. - There are five major number formats - + There are five major number formats: o+ o zero - a number which contains all zero bits. + A number which contains all zero bits. o subnormal - Is used to represent number with a zero exponent, but a nonzero fract -ion. - o normal - A number with an exponent, and a fraction + A number with a zero exponent but a nonzero fraction. + o normal + A number with an exponent and a fraction. o infinity A number with an all 1's exponent and a zero fraction. o NAN @@ -69,7 +68,7 @@ ion. returns 1 if the argument is infinity. <<finite>> returns 1 if the argument is zero, subnormal or normal. - The <<isnanf>>, <<isinff>> and <<finitef>> perform the same + The <<isnanf>>, <<isinff>> and <<finitef>> functions perform the same operations as their <<isnan>>, <<isinf>> and <<finite>> counterparts, but on single-precision floating-point numbers. diff --git a/newlib/libm/mathfp/s_ldexp.c b/newlib/libm/mathfp/s_ldexp.c index 5ce2710ac..6da41284b 100644 --- a/newlib/libm/mathfp/s_ldexp.c +++ b/newlib/libm/mathfp/s_ldexp.c @@ -45,7 +45,7 @@ On underflow, <<ldexp>> and <<ldexpf>> return 0.0. On overflow, <<ldexp>> returns plus or minus <<HUGE_VAL>>. PORTABILITY -<<ldexp>> is ANSI, <<ldexpf>> is an extension. +<<ldexp>> is ANSI. <<ldexpf>> is an extension. */ diff --git a/newlib/libm/mathfp/s_logarithm.c b/newlib/libm/mathfp/s_logarithm.c index ee7c7069e..3e07949c8 100644 --- a/newlib/libm/mathfp/s_logarithm.c +++ b/newlib/libm/mathfp/s_logarithm.c @@ -56,8 +56,9 @@ When <[x]> is negative, the returned value is <<-HUGE_VAL>> and <<matherr>>. PORTABILITY -<<log>> is ANSI, <<logf>> is an extension. -<<log10>> is ANSI, <<log10f>> is an extension. +<<log>> is ANSI. <<logf>> is an extension. + +<<log10>> is ANSI. <<log10f>> is an extension. */ diff --git a/newlib/libm/mathfp/w_jn.c b/newlib/libm/mathfp/w_jn.c index bd7878104..14c2225f0 100644 --- a/newlib/libm/mathfp/w_jn.c +++ b/newlib/libm/mathfp/w_jn.c @@ -13,7 +13,7 @@ /* FUNCTION -<<jN>>,<<jNf>>,<<yN>>,<<yNf>>---Bessel functions +<<jN>>, <<jNf>>, <<yN>>, <<yNf>>---Bessel functions INDEX j0 |