]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Document Internal EVP_MD_CTX_ Flags
authorerbsland-dev <github@erbsland.dev>
Thu, 11 Jul 2024 12:02:53 +0000 (14:02 +0200)
committerTomas Mraz <tomas@openssl.org>
Fri, 12 Jul 2024 13:54:35 +0000 (15:54 +0200)
Add documentation for the internal flags `EVP_MD_CTX_FLAG_CLEANED` and
`EVP_MD_CTX_FLAG_REUSE`, explicitly stating that these flags are for
internal use only and must not be used in user code.

Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/24829)

doc/man3/EVP_DigestInit.pod

index aeae8e81e6d2f900e8b36b0a19d68057fb62001d..70d0836ec26a9fdb130591b51e51c031ad05b294 100644 (file)
@@ -550,9 +550,13 @@ can be used the manipulate and test these B<EVP_MD_CTX> flags:
 
 This flag instructs the digest to optimize for one update only, if possible.
 
-=for comment EVP_MD_CTX_FLAG_CLEANED is internal, don't mention it
+=item EVP_MD_CTX_FLAG_CLEANED
 
-=for comment EVP_MD_CTX_FLAG_REUSE is internal, don't mention it
+This flag is for internal use only and I<must not> be used in user code.
+
+=item EVP_MD_CTX_FLAG_REUSE
+
+This flag is for internal use only and I<must not> be used in user code.
 
 =for comment We currently avoid documenting flags that are only bit holder:
 EVP_MD_CTX_FLAG_NON_FIPS_ALLOW, EVP_MD_CTX_FLAGS_PAD_*