Commit 9e98185a10 for openssl.org
commit 9e98185a1072a8918b1a0ecefbde81f32112c714
Author: Eugene Syromiatnikov <esyr@openssl.org>
Date: Wed Sep 23 03:27:48 2026 +0200
doc/man3/ASN1_STRING_length.pod: cleanup NUL byte non-guarantee paragraph
- Replace "null" bytes with "NUL" (as spelled elsewhere).
- Use proper formatting for "IA5String", "BMPString", "UTF8String".
- Add missing punctuation.
- Minor rewording with respect to Unicode encoding.
Signed-off-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.foundation>
Reviewed-by: Nikola Pajkovsky <nikolap@openssl.org>
Merge-date: Tue Nov 10 15:07:03 2026
Merged-from: https://github.com/openssl/openssl/pull/32937
diff --git a/doc/man3/ASN1_STRING_length.pod b/doc/man3/ASN1_STRING_length.pod
index f5a60edce0..cd40f49102 100644
--- a/doc/man3/ASN1_STRING_length.pod
+++ b/doc/man3/ASN1_STRING_length.pod
@@ -145,12 +145,13 @@ These functions should B<not> be used to examine or modify B<ASN1_INTEGER>
or B<ASN1_ENUMERATED> types: the relevant B<INTEGER> or B<ENUMERATED>
utility functions should be used instead.
-In general it cannot be assumed that the data returned by
-ASN1_STRING_get0_data() is null terminated or does not contain
-embedded nulls. The actual format of the data will depend on the
-actual string type itself: for example for an IA5String the data will
-be ASCII, for a BMPString two bytes per character in big endian
-format, and for a UTF8String it will be in UTF8 format.
+In general, it cannot be assumed that the data returned
+by ASN1_STRING_get0_data() is NUL-terminated or does not contain
+embedded NUL bytes. The actual format of the data will depend
+on the actual string type itself: for example, for an B<IA5String>, the data
+will be ASCII; for a B<BMPString>, it will be two bytes per character
+in big endian format without BOM; and for a B<UTF8String>, it will be encoded
+in UTF-8.
Similar care should be taken to ensure the data is in the correct
format when calling ASN1_STRING_set(), ASN1_STRING_set1_data(), or