From 239c2bf93e32e147dab3e6cde99078d1ad5a1ef5 Mon Sep 17 00:00:00 2001 From: Jeff Johnston Date: Fri, 28 Oct 2005 21:21:08 +0000 Subject: 2005-10-28 Bob Wilson * 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. --- newlib/libc/stdlib/a64l.c | 55 ++++++++++++++++++++++++-------------------- newlib/libc/stdlib/assert.c | 2 +- newlib/libc/stdlib/efgcvt.c | 2 +- newlib/libc/stdlib/envlock.c | 2 +- newlib/libc/stdlib/mlock.c | 2 +- newlib/libc/stdlib/mstats.c | 2 +- newlib/libc/stdlib/rand.c | 4 ++-- newlib/libc/stdlib/rand48.c | 2 +- 8 files changed, 38 insertions(+), 33 deletions(-) (limited to 'newlib/libc/stdlib') 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 -<>,<>---convert between radix-64 ascii string and long +<>, <>---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 <> 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 <> 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 +<> 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 <> 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 -<> returns a nul-terminated string of 0 to 6 characters. +<> returns a null-terminated string of 0 to 6 characters. <> 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 -<>---Macro for Debugging Diagnostics +<>---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 -<>,<>,<>,<>---double or float to string +<>, <>, <>, <>---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 -<>, <>, <>--malloc support +<>, <>, <>---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 <> (inclusive). <> does not return a result. NOTES -<> and <> are unsafe for multi-thread applications. -<> is MT-Safe and should be used instead. +<> and <> are unsafe for multi-threaded applications. +<> 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 - <>, <>, <>, <>, <>, <>, <>, <>, <>, <> ---pseudo random number generators and initialization routines + <>, <>, <>, <>, <>, <>, <>, <>, <>, <>---pseudo-random number generators and initialization routines INDEX rand48 -- cgit v1.2.3