[hackers] [libgrapheme] Fix a few small errors in the manpages || Laslo Hunhold

From: <git_AT_suckless.org>
Date: Sun, 2 Oct 2022 22:23:50 +0200 (CEST)

commit 995e37182dc53da55dc4cf34868513610215c79e
Author: Laslo Hunhold <dev_AT_frign.de>
AuthorDate: Sun Oct 2 22:22:54 2022 +0200
Commit: Laslo Hunhold <dev_AT_frign.de>
CommitDate: Sun Oct 2 22:22:54 2022 +0200

    Fix a few small errors in the manpages
    
    Thanks to NRK for spotting most of these problems! In the other cases,
    mandoc with its Tlint-flag proved to be very useful.
    
    Signed-off-by: Laslo Hunhold <dev_AT_frign.de>

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/next_break.sh b/man/template/next_break.sh
index c25ab38..fee6187 100644
--- a/man/template/next_break.sh
+++ b/man/template/next_break.sh
_AT_@ -38,12 +38,12 @@ is set to
 .Dv SIZE_MAX
 (stdint.h is already included by grapheme.h) the string
 .Va str
-is interpreted to be NUL-terminated and processing stops when a
-NUL-byte is encountered.
+is interpreted to be NUL-terminated and processing stops when
+a $(if [ "$ENCODING" = "utf8" ]; then printf "NUL-byte"; else printf "codepoint with the value 0"; fi) is encountered.
 .Pp
 For $(if [ "$ENCODING" != "utf8" ]; then printf "UTF-8-encoded"; else printf "non-UTF-8"; fi) input
 data$(if [ "$TYPE" = "character" ] && [ "$ENCODING" = "utf8" ]; then printf "\n.Xr grapheme_is_character_break 3 and"; fi)
-.Xr grapheme_next_${TYPE}_break${ANTISUFFIX}
+.Xr grapheme_next_${TYPE}_break${ANTISUFFIX} 3
 can be used instead.
 .Sh RETURN VALUES
 The
_AT_@ -102,7 +102,7 @@ fi
 
 cat << EOF
 .Sh SEE ALSO$(if [ "$TYPE" = "character" ] && [ "$ENCODING" != "utf8" ]; then printf "\n.Xr grapheme_is_character_break 3 ,"; fi)
-.Xr grapheme_next_${TYPE}_break${ANTISUFFIX}
+.Xr grapheme_next_${TYPE}_break${ANTISUFFIX} 3 ,
 .Xr libgrapheme 7
 .Sh STANDARDS
 .Fn grapheme_next_${TYPE}_break${SUFFIX}
diff --git a/man/template/to_case.sh b/man/template/to_case.sh
index 89b8996..55f92f4 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 destlen
 is not large enough or
 .Va dest
 is
Received on Sun Oct 02 2022 - 22:23:50 CEST