From: Kevin Day Date: Sat, 6 Jul 2024 05:30:05 +0000 (-0500) Subject: Cleanup: Fix incorrect documentation regarding the print functions and the length... X-Git-Tag: 0.6.11~34 X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=9dc9951b493a7639742084e55f290a3ed838f568;p=fll Cleanup: Fix incorrect documentation regarding the print functions and the length parameters. --- diff --git a/level_0/f_print/c/print.h b/level_0/f_print/c/print.h index ade3bf6..b4d793f 100644 --- a/level_0/f_print/c/print.h +++ b/level_0/f_print/c/print.h @@ -218,7 +218,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -325,7 +325,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -361,7 +361,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -395,7 +395,6 @@ extern "C" { * * Will not stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -653,7 +652,7 @@ extern "C" { * Will not stop at NULL. * Will print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -693,7 +692,7 @@ extern "C" { * Will not stop at NULL. * Will print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -731,7 +730,7 @@ extern "C" { * Will not stop at NULL. * Will not print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -886,7 +885,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1011,7 +1010,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1475,7 +1474,6 @@ extern "C" { * * Will stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -1570,7 +1568,6 @@ extern "C" { * * Will stop at NULL. * Will not print NULL (even as a control character symbol). - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -1601,7 +1598,6 @@ extern "C" { * * Will stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * diff --git a/level_0/f_print/c/print/to.h b/level_0/f_print/c/print/to.h index 5fd615d..7cbe8da 100644 --- a/level_0/f_print/c/print/to.h +++ b/level_0/f_print/c/print/to.h @@ -309,7 +309,7 @@ extern "C" { * * Will not stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * @param buffer * The string to output. @@ -349,7 +349,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -394,7 +394,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -437,7 +437,7 @@ extern "C" { * * Will not stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * @param buffer * The string to output. @@ -801,7 +801,7 @@ extern "C" { * Will not stop at NULL. * Will print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -1043,7 +1043,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1199,7 +1199,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1766,7 +1766,6 @@ extern "C" { * * Will stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * diff --git a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_partial_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_partial_raw.3 index ef5af1e..831977e 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_partial_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_partial_raw.3 @@ -15,7 +15,7 @@ f_print_dynamic_partial_raw .PP Similar to a c-library printf, except that this will only print a specific range in a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will print up to the specified range within the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .PP diff --git a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw.3 index eae4417..91e1f6c 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw.3 @@ -14,7 +14,7 @@ f_print_dynamic_raw .PP Similar to a c-library printf, except that this prints a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will print up to the length of the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .PP diff --git a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw_safely.3 b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw_safely.3 index 7608008..3fe6c6d 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw_safely.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw_safely.3 @@ -18,7 +18,7 @@ This is essentually a "safe" print that also prints NULL. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will not stop at NULL. Will print NULL. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will print up to the length of the buffer. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_safely.3 b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_safely.3 index 0a26a19..18e047d 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_dynamic_safely.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_dynamic_safely.3 @@ -16,7 +16,7 @@ Similar to a c-library printf, except that this prints a given dynamic string. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will not stop at NULL. Will not print NULL. Will print up to length 1-byte characters. +Will not stop at NULL. Will not print NULL. Will print up to the length of the buffer. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw.3 index 6907262..5234c0f 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw.3 @@ -15,7 +15,7 @@ f_print_except_dynamic_raw .PP Similar to a c-library printf, except that this prints a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to the length of the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .PP diff --git a/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw_safely.3 b/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw_safely.3 index 984ae11..96b5ffc 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw_safely.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw_safely.3 @@ -19,7 +19,7 @@ This is essentually a "safe" print that also prints NULL. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to the length of the buffer. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_safely.3 b/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_safely.3 index 0f34526..7459cc3 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_safely.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_safely.3 @@ -17,7 +17,7 @@ Similar to a c-library printf, except that this prints a given dynamic string. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will not stop at NULL. Will not print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to length 1-byte characters. +Will not stop at NULL. Will not print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to the length of the buffer. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_partial_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_partial_raw.3 index a0f0b54..cea772a 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_partial_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_partial_raw.3 @@ -17,7 +17,7 @@ f_print_except_in_dynamic_partial_raw .PP Similar to a c-library printf, except that this will only print a specific range in a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to the specified range within the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .PP diff --git a/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_raw.3 index aa87517..803520e 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_raw.3 @@ -16,7 +16,7 @@ f_print_except_in_dynamic_raw .PP Similar to a c-library printf, except that this prints a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to the length of the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .PP diff --git a/level_0/f_print/data/documentation/man/man3/f_print_raw_terminated.3 b/level_0/f_print/data/documentation/man/man3/f_print_raw_terminated.3 index 7b6e138..de361f2 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_raw_terminated.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_raw_terminated.3 @@ -14,7 +14,7 @@ f_print_raw_terminated .PP Similar to a c-library printf. .PP -Will stop at NULL. Will not print NULL. Will print up to length 1-byte characters. +Will stop at NULL. Will not print NULL. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_safely_terminated.3 b/level_0/f_print/data/documentation/man/man3/f_print_safely_terminated.3 index 0402843..490ff13 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_safely_terminated.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_safely_terminated.3 @@ -16,7 +16,7 @@ Similar to a c-library printf. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will stop at NULL. Will not print NULL (even as a control character symbol). Will print up to length 1-byte characters. +Will stop at NULL. Will not print NULL (even as a control character symbol). .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_terminated.3 b/level_0/f_print/data/documentation/man/man3/f_print_terminated.3 index d853697..15db056 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_terminated.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_terminated.3 @@ -14,7 +14,7 @@ f_print_terminated .PP Similar to a c-library printf. .PP -Will stop at NULL. Will not print NULL. Will print up to length 1-byte characters. +Will stop at NULL. Will not print NULL. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw.3 index d988d8d..7b7e30a 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw.3 @@ -14,7 +14,7 @@ f_print_to_dynamic_raw .PP Similar to a c-library dprintf, except that this prints a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will print up to the length of the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw_safely.3 b/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw_safely.3 index ec891cc..9c9da57 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw_safely.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw_safely.3 @@ -18,7 +18,7 @@ This is essentually a "safe" print that also prints NULL. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will not stop at NULL. Will print NULL. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will print up to the length of the buffer. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_safely.3 b/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_safely.3 index 6176d10..4a2c104 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_safely.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_safely.3 @@ -16,7 +16,7 @@ Similar to a c-library dprintf, except that this prints a given dynamic string. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will not stop at NULL. Will not print NULL. Will print up to length 1-byte characters. +Will not stop at NULL. Will not print NULL. Will print up to the length of the buffer. .SH PARAMETERS .TP .B buffer diff --git a/level_0/f_print/data/documentation/man/man3/f_print_to_except_dynamic_raw_safely.3 b/level_0/f_print/data/documentation/man/man3/f_print_to_except_dynamic_raw_safely.3 index dc8aa84..257d2a0 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_to_except_dynamic_raw_safely.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_to_except_dynamic_raw_safely.3 @@ -19,7 +19,7 @@ This is essentually a "safe" print that also prints NULL. .PP Control characters are converted to the Unicode control character symbols, excluding NULL. UTF-8 sequences with invalid widths are converted to the unknown character '�'. .PP -Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except array. Will print up to the length of the buffer. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS diff --git a/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_partial_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_partial_raw.3 index c7f7480..d4e2ddf 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_partial_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_partial_raw.3 @@ -17,7 +17,7 @@ f_print_to_except_in_dynamic_partial_raw .PP Similar to a c-library printf, except that this will only print a specific range in a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to the specified range within the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .PP diff --git a/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_raw.3 b/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_raw.3 index c294c9b..b441662 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_raw.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_raw.3 @@ -16,7 +16,7 @@ f_print_to_except_in_dynamic_raw .PP Similar to a c-library printf, except that this prints a given dynamic string. .PP -Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to length 1-byte characters. +Will not stop at NULL. Will print NULL. Will not print any 1-byte character at a location specified in except_at array. Will not print any 1-byte character within the ranges specified in except_in array. Will print up to the length of the buffer. .PP All UTF-8 characters, invalid or not, are printed as is. .PP diff --git a/level_0/f_print/data/documentation/man/man3/f_print_to_raw_terminated.3 b/level_0/f_print/data/documentation/man/man3/f_print_to_raw_terminated.3 index bb606ff..6aef594 100644 --- a/level_0/f_print/data/documentation/man/man3/f_print_to_raw_terminated.3 +++ b/level_0/f_print/data/documentation/man/man3/f_print_to_raw_terminated.3 @@ -14,7 +14,7 @@ f_print_to_raw_terminated .PP Similar to a c-library printf. .PP -Will stop at NULL. Will not print NULL. Will print up to length 1-byte characters. +Will stop at NULL. Will not print NULL. .PP This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. .SH PARAMETERS