Document Internal EVP_MD_CTX_ Flags

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)
This commit is contained in:
erbsland-dev 2024-07-11 14:02:53 +02:00 committed by Tomas Mraz
parent 20da3dabc4
commit b74646b627

View 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_*