summaryrefslogtreecommitdiffstats
path: root/newlib/libc/string
diff options
context:
space:
mode:
authorJeff Johnston <jjohnstn@redhat.com>2005-10-28 21:21:08 +0000
committerJeff Johnston <jjohnstn@redhat.com>2005-10-28 21:21:08 +0000
commit239c2bf93e32e147dab3e6cde99078d1ad5a1ef5 (patch)
treece34a06bc2f7aa30c01d990662463072df296bc6 /newlib/libc/string
parent39e9e2b0c972dee5cbcb1a0c10c175805c647e51 (diff)
downloadcygnal-239c2bf93e32e147dab3e6cde99078d1ad5a1ef5.tar.gz
cygnal-239c2bf93e32e147dab3e6cde99078d1ad5a1ef5.tar.bz2
cygnal-239c2bf93e32e147dab3e6cde99078d1ad5a1ef5.zip
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.
Diffstat (limited to 'newlib/libc/string')
-rw-r--r--newlib/libc/string/bcmp.c2
-rw-r--r--newlib/libc/string/memchr.c4
-rw-r--r--newlib/libc/string/strcspn.c2
-rw-r--r--newlib/libc/string/strerror_r.c2
-rw-r--r--newlib/libc/string/strncat.c1
-rw-r--r--newlib/libc/string/strnlen.c2
-rw-r--r--newlib/libc/string/strpbrk.c2
-rw-r--r--newlib/libc/string/strtok.c26
-rw-r--r--newlib/libc/string/wcscat.c1
-rw-r--r--newlib/libc/string/wcschr.c1
-rw-r--r--newlib/libc/string/wcscmp.c1
-rw-r--r--newlib/libc/string/wcscpy.c1
-rw-r--r--newlib/libc/string/wcscspn.c1
-rw-r--r--newlib/libc/string/wcslen.c1
-rw-r--r--newlib/libc/string/wcsncat.c1
-rw-r--r--newlib/libc/string/wcsncmp.c1
-rw-r--r--newlib/libc/string/wcsncpy.c1
-rw-r--r--newlib/libc/string/wcsnlen.c3
-rw-r--r--newlib/libc/string/wcspbrk.c1
-rw-r--r--newlib/libc/string/wcsrchr.c1
-rw-r--r--newlib/libc/string/wcsspn.c1
-rw-r--r--newlib/libc/string/wcswidth.c18
-rw-r--r--newlib/libc/string/wcwidth.c12
-rw-r--r--newlib/libc/string/wmemchr.c1
-rw-r--r--newlib/libc/string/wmemcmp.c1
-rw-r--r--newlib/libc/string/wmemcpy.c1
-rw-r--r--newlib/libc/string/wmemmove.c3
-rw-r--r--newlib/libc/string/wmemset.c1
28 files changed, 54 insertions, 39 deletions
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.
*/