Clarify documentation of X509_STORE_CTX_get_current_cert()
authornorth-16 <sfustudent0095@gmail.com>
Fri, 13 Jan 2023 01:33:46 +0000 (17:33 -0800)
committerTomas Mraz <tomas@openssl.org>
Tue, 17 Jan 2023 11:43:36 +0000 (12:43 +0100)
CLA: trivial

Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20038)

doc/man3/X509_STORE_CTX_get_error.pod

index 90ebcac45f51025d28dd538c5487034c3b71a11f..76fcf27b8dae59e74b454e3ce1e66c790f945bc4 100644 (file)
@@ -49,8 +49,10 @@ X509_STORE_CTX_set_error_depth() sets the error I<depth>.
 This can be used in combination with X509_STORE_CTX_set_error() to set the
 depth at which an error condition was detected.
 
-X509_STORE_CTX_get_current_cert() returns the certificate in I<ctx> which
-caused the error or NULL if no certificate is relevant.
+X509_STORE_CTX_get_current_cert() returns the current certificate in
+I<ctx>. If an error occurred, the current certificate will be the one
+that is most closely related to the error, or possibly NULL if no such
+certificate is relevant.
 
 X509_STORE_CTX_set_current_cert() sets the certificate I<x> in I<ctx> which
 caused the error.