SSL_add_dir_cert_subjects_to_stack(): Documented return values
authorShakti Shah <shaktishah33@gmail.com>
Tue, 30 Jan 2024 18:56:32 +0000 (00:26 +0530)
committerTomas Mraz <tomas@openssl.org>
Fri, 15 Mar 2024 09:16:16 +0000 (10:16 +0100)
In the man page for SSL_add_dir_cert_subjects_to_stack(), the functions
returning int have undocumented return values.

Fixes #23171

Signed-off-by: Shakti Shah <shaktishah33@gmail.com>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/23433)

(cherry picked from commit 9f3a7ca2cfff948b21f8fdbe92069b3eea1c01fa)

doc/man3/SSL_load_client_CA_file.pod

index 988c7e89340755ea28d7541dd42dca08e264ec4e..117f6bb1a94fc4ae78ee3af4b8bfc6c60f08e583 100644 (file)
@@ -54,7 +54,8 @@ it is not limited to CA certificates.
 
 =head1 RETURN VALUES
 
-The following return values can occur:
+The following return values can occur for SSL_load_client_CA_file_ex(), and
+SSL_load_client_CA_file():
 
 =over 4
 
@@ -68,6 +69,21 @@ Pointer to the subject names of the successfully read certificates.
 
 =back
 
+The following return values can occur for SSL_add_file_cert_subjects_to_stack(),
+SSL_add_dir_cert_subjects_to_stack(), and SSL_add_store_cert_subjects_to_stack():
+
+=over 4
+
+=item 0 (Failure)
+
+The operation failed.
+
+=item 1 (Success)
+
+The operation succeeded.
+
+=back
+
 =head1 EXAMPLES
 
 Load names of CAs from file and use it as a client CA list: