]> Kevux Git Server - fll/commitdiff
Cleanup: Fix incorrect documentation regarding the print functions and the length...
authorKevin Day <Kevin@kevux.org>
Sat, 6 Jul 2024 05:30:05 +0000 (00:30 -0500)
committerKevin Day <Kevin@kevux.org>
Sat, 6 Jul 2024 05:30:05 +0000 (00:30 -0500)
21 files changed:
level_0/f_print/c/print.h
level_0/f_print/c/print/to.h
level_0/f_print/data/documentation/man/man3/f_print_dynamic_partial_raw.3
level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw.3
level_0/f_print/data/documentation/man/man3/f_print_dynamic_raw_safely.3
level_0/f_print/data/documentation/man/man3/f_print_dynamic_safely.3
level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw.3
level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_raw_safely.3
level_0/f_print/data/documentation/man/man3/f_print_except_dynamic_safely.3
level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_partial_raw.3
level_0/f_print/data/documentation/man/man3/f_print_except_in_dynamic_raw.3
level_0/f_print/data/documentation/man/man3/f_print_raw_terminated.3
level_0/f_print/data/documentation/man/man3/f_print_safely_terminated.3
level_0/f_print/data/documentation/man/man3/f_print_terminated.3
level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw.3
level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_raw_safely.3
level_0/f_print/data/documentation/man/man3/f_print_to_dynamic_safely.3
level_0/f_print/data/documentation/man/man3/f_print_to_except_dynamic_raw_safely.3
level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_partial_raw.3
level_0/f_print/data/documentation/man/man3/f_print_to_except_in_dynamic_raw.3
level_0/f_print/data/documentation/man/man3/f_print_to_raw_terminated.3

index ade3bf6b842160c42ae88495d20a52f61c07b52a..b4d793ff73f1c4406f0092368e9d4d09e035701d 100644 (file)
@@ -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.
  *
index 5fd615dae329fb5bef4b5965ee644a8b7f61f4c3..7cbe8dafe5d6ef532f6746f005c7f6c8d43612aa 100644 (file)
@@ -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.
  *
index ef5af1e14d07efedd34d4fe21d2003332f6329b5..831977e1e00535ddebc01a140eb90f16ddc3728c 100644 (file)
@@ -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
index eae4417880c7448869cf467ee6aa32892d9a8bc3..91e1f6caa323d9257a8584e40ec777793bfd9518 100644 (file)
@@ -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
index 760800858bd34b30c8cb89cc5e785456c2eb3ab8..3fe6c6d621e2578d20de9b0e9c427182caf139ab 100644 (file)
@@ -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
index 0a26a194fac0211a0c10eee904acd1d3e776d13c..18e047d4b8962048530a3f297e65edcfd563b62e 100644 (file)
@@ -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
index 690726211738e01b65b295dd5e573f690da6039d..5234c0fecba261ed73e9af3cb4d8e11b5a4c0c57 100644 (file)
@@ -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
index 984ae1120ed6e8743e913b8355b0015ee17c4e7b..96b5ffc9b584a5c1e4d77309210245bfbb7ad134 100644 (file)
@@ -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
index 0f345263ea6ef04e9bbbada2af1aa8205b72dab1..7459cc3c61de972451e98ee3c29cb05f1441e8a1 100644 (file)
@@ -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
index a0f0b54297dad378d00e6305a5ef0234f86f8ff0..cea772a7f73c30f9a18b8ed97c8af23aa7f9ed1a 100644 (file)
@@ -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
index aa87517b8612d3484411919bc834cfcb431edb38..803520e82e37ee3bc93eef1f2e11e5992aeda572 100644 (file)
@@ -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
index 7b6e13866730e2eae5d0f549b33bcb03bc300047..de361f2e89237b02ccc92cf21e7056afa793a85a 100644 (file)
@@ -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
index 0402843d7a8e830a559334cfcffced2d6f82e2ae..490ff13058dcf67776176a75939d6bd5f9fa389d 100644 (file)
@@ -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
index d853697640bcf6a94272b4d4825d008d41c27bef..15db056777053040038a123f3a28c51593cfd1a7 100644 (file)
@@ -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
index d988d8d869838c41eac2c973a9c73c20ca9cdb7d..7b7e30a3a73df08bf8409cc562b867e26ef8726a 100644 (file)
@@ -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
index ec891ccddcf459c517b949e8486c7ddbc7694961..9c9da57f50bb0d79eac9bbf8d9f1a39942622338 100644 (file)
@@ -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
index 6176d1031842f4c7d527672ff8c5a55cf2498c88..4a2c1043495960dde2efb9f753fa302b6c3be4e1 100644 (file)
@@ -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
index dc8aa84adbb403d4d557e0a2deae027efaded324..257d2a0adf81d928b7abf4e3f04a4db495bface7 100644 (file)
@@ -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
index c7f74800ee6490b3402f0e5ff35dbdf4350835f8..d4e2ddfc5956eb0f53d46a3f6c16eee522548c12 100644 (file)
@@ -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
index c294c9bcc8d57e8836daadccba9f494a9c131b0b..b441662f27419c616fbee7d43260fccaa1a44ed6 100644 (file)
@@ -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
index bb606ff0f1f48b43b96dc54c006037469eb6a394..6aef5944ed50b1a79aa232f0d81103d59326a768 100644 (file)
@@ -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