From: Alejandro Colomar <alx@kernel.org>
To: serge@hallyn.com
Cc: linux-man@vger.kernel.org
Subject: string_copying.7: Clarifying ustr and zustr
Date: Tue, 10 Oct 2023 16:09:05 +0200 [thread overview]
Message-ID: <ZSVbASi04xwzNFyr@debian> (raw)
[-- Attachment #1: Type: text/plain, Size: 2778 bytes --]
Hi Serge,
I'm clarifying zustr after your suggestion. Please check this text.
DESCRIPTION
Terms (and abbreviations)
string (str)
is a sequence of zero or more non‐null characters fol‐
lowed by a null byte.
character sequence
is a sequence of zero or more non‐null characters. A
program should never use a character sequence where a
string is required. However, with appropriate care, a
string can be used in the place of a character sequence.
null‐padded character sequence (zustr)
Character sequences can be contained in fixed‐
width buffers, which contain padding null bytes
after the character sequence, to fill the rest of
the buffer without affecting the character se‐
quence; however, those padding null bytes are not
part of the character sequence. zustr stands for
Zero‐padded Unterminated STRing. Don’t confuse
zero‐padded with null‐terminated: zero‐padded
means 0 or more padding zeros (null characters),
while null‐terminated means exactly 1 terminating
null character.
measured character sequence (ustr)
Character sequence delimited by its length. It
may be a slice of a larger character sequence, or
even of a string. ustr stands for Unterminated
STRing.
The patch is:
diff --git a/man7/string_copying.7 b/man7/string_copying.7
index e03c2dda6..c5f374025 100644
--- a/man7/string_copying.7
+++ b/man7/string_copying.7
@@ -102,12 +102,19 @@ .SS Terms (and abbreviations)
to fill the rest of the buffer
without affecting the character sequence;
however, those padding null bytes are not part of the character sequence.
+.I zustr
+stands for Zero-padded Unterminated STRing.
+Don't confuse zero-padded with null-terminated:
+zero-padded means 0 or more padding zeros (null characters),
+while null-terminated means exactly 1 terminating null character.
.\" ----- DESCRIPTION :: Terms (and abbreviations) :: measured character sequence
.TP
.IR "measured character sequence " ( ustr )
Character sequence delimited by its length.
It may be a slice of a larger character sequence,
or even of a string.
+.I ustr
+stands for Unterminated STRing.
.RE
.\" ----- DESCRIPTION :: Terms (and abbreviations) :: length (len) ----/
.TP
Thanks,
Alex
--
<https://www.alejandro-colomar.es/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next reply other threads:[~2023-10-10 14:09 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-10 14:09 Alejandro Colomar [this message]
2023-10-11 20:39 ` string_copying.7: Clarifying ustr and zustr Serge E. Hallyn
2023-10-12 0:34 ` Alejandro Colomar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZSVbASi04xwzNFyr@debian \
--to=alx@kernel.org \
--cc=linux-man@vger.kernel.org \
--cc=serge@hallyn.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox