]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: add return value documentation for EVP_CIPHER_*_params functions
authorkovan <xaum.io@gmail.com>
Tue, 27 Jan 2026 06:44:55 +0000 (07:44 +0100)
committerTomas Mraz <tomas@openssl.org>
Tue, 3 Feb 2026 09:51:36 +0000 (10:51 +0100)
Document that EVP_CIPHER_get_params(), EVP_CIPHER_CTX_get_params() and
EVP_CIPHER_CTX_set_params() return 1 for success and 0 for failure.

Fixes #29725

CLA: trivial

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
MergeDate: Tue Feb  3 09:51:47 2026
(Merged from https://github.com/openssl/openssl/pull/29779)

doc/man3/EVP_EncryptInit.pod

index aad412652c7ed5b97b3d36933e072b9ed9bc87f0..b2deb49ee391a7af21898f83da3f6d3362d79db4 100644 (file)
@@ -1468,6 +1468,9 @@ for failure.
 EVP_CIPHER_names_do_all() returns 1 if the callback was called for all names.
 A return value of 0 means that the callback was not called for any names.
 
+EVP_CIPHER_get_params(), EVP_CIPHER_CTX_get_params() and
+EVP_CIPHER_CTX_set_params() return 1 for success and 0 for failure.
+
 =head1 CIPHER LISTING
 
 All algorithms have a fixed key length unless otherwise stated.