[hackers] [libgrapheme][PATCH] fix manpage

From: NRK <nrk_AT_disroot.org>
Date: Sun, 2 Oct 2022 09:29:18 +0600

- to_case: there's no `len` parameter. it should be `srclen` and `dstlen`.
- is_case: `caselen` should be a pointer.

---
P.S: one more thing that caught my eye; the "next" manpages for the
codepoint versions states:
	If len is set to SIZE_MAX the string str is interpreted to be
	NUL-terminated and processing stops when a NUL-byte is
	encountered.
is this correct? what if the integer contains a nul-byte?
it seems to be that it should be an integer (uint_least32_t) with the
value 0, not a nul-byte, which are different things.
 man/template/is_case.sh | 4 ++--
 man/template/to_case.sh | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/man/template/is_case.sh b/man/template/is_case.sh
index 8ef2869..3cf00e6 100644
--- a/man/template/is_case.sh
+++ b/man/template/is_case.sh
_AT_@ -22,7 +22,7 @@ cat << EOF
 .Sh SYNOPSIS
 .In grapheme.h
 .Ft size_t
-.Fn grapheme_is_${CASE}${SUFFIX} "const ${DATATYPE} *str" "size_t len" "size_t caselen"
+.Fn grapheme_is_${CASE}${SUFFIX} "const ${DATATYPE} *str" "size_t len" "size_t *caselen"
 .Sh DESCRIPTION
 The
 .Fn grapheme_is_${CASE}${SUFFIX}
_AT_@ -54,7 +54,7 @@ function returns
 .Dv true
 if the ${ARRAYTYPE}
 .Va str
-is ${CASE}, otherwise 
+is ${CASE}, otherwise
 .Dv false .
 .Sh SEE ALSO
 .Xr grapheme_is_${CASE}${ANTISUFFIX} 3 ,
diff --git a/man/template/to_case.sh b/man/template/to_case.sh
index 89b8996..8f17e53 100644
--- a/man/template/to_case.sh
+++ b/man/template/to_case.sh
_AT_@ -38,7 +38,7 @@ is set to
 .Dv NULL .
 .Pp
 If
-.Va len
+.Va srclen
 is set to
 .Dv SIZE_MAX
 (stdint.h is already included by grapheme.h) the ${ARRAYTYPE}
_AT_@ -56,7 +56,7 @@ function returns the number of ${UNIT}s in the array resulting
 from converting
 .Va src
 to ${CASE}, even if
-.Va len
+.Va dstlen
 is not large enough or
 .Va dest
 is
-- 
2.35.1

Received on Sun Oct 02 2022 - 05:29:18 CEST