procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Fix last change in documentation of 'strz' bindat type

Browse source 
* doc/lispref/processes.texi (Bindat Types): Fix wording and
clarify the description of 'strz'.  (Bug#55952)
This commit is contained in:
Eli Zaretskii 2022-06-16 10:08:10 +03:00
parent 6c3b6149d9
commit 61bdad4685
1 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
doc/lispref/processes.texi
View file

@ -3493,21 +3493,26 @@ any null bytes in the packed input string will appear in the unpacked
output.
@item strz &optional @var{len}
If @var{len} is not provided: Variable-length null-terminated unibyte
string (@pxref{Text Representations}). When packing, the entire input
string is copied to the packed output followed by a null (zero) byte.
The length of the packed output is the length of the input string plus
one (for the null terminator). The input string must not contain any
null bytes. If the input string is multibyte with only ASCII and
If @var{len} is not provided, this is a variable-length
null-terminated unibyte string (@pxref{Text Representations}). When
packing into @code{strz}, the entire input string is copied to the
packed output followed by a null (zero) byte. (If pre-allocated
string is provided for packing into @code{strz}, that pre-allocated
string should have enough space for the additional null byte appended
to the output string contents, @pxref{Bindat Functions}). The length
of the packed output is the length of the input string plus one (for
the null terminator). The input string must not contain any null
bytes. If the input string is multibyte with only ASCII and
@code{eight-bit} characters, it is converted to unibyte before it is
packed; other multibyte strings signal an error. When unpacking, the
resulting string contains all bytes up to (but excluding) the null
byte.
packed; other multibyte strings signal an error. When unpacking a
@code{strz}, the resulting output string will contain all bytes up to
(but excluding) the null byte that terminated the input string.
If @var{len} is provided: @code{strz} behaves the same as @code{str}
with one difference: When unpacking, the first null byte encountered
in the packed string and all subsequent bytes are excluded from the
unpacked result.
If @var{len} is provided, @code{strz} behaves the same as @code{str},
but with one difference: when unpacking, the first null byte
encountered in the packed string is interpreted as the terminating
byte, and it and all subsequent bytes are excluded from the result of
the unpacking.
@quotation Caution
The packed output will not be null-terminated unless one of the