CMS_add1_signer.pod: add missing info on CMS_SignerInfo_sign() return values
authorDr. David von Oheimb <dev@ddvo.net>
Fri, 13 Oct 2023 20:39:25 +0000 (22:39 +0200)
committerDr. David von Oheimb <dev@ddvo.net>
Tue, 17 Oct 2023 20:08:15 +0000 (22:08 +0200)
Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22390)

(cherry picked from commit 2c581eb2fd92e997dfe0761b086eb690271cefc2)

doc/man3/CMS_add1_signer.pod

index 800085b7b86a9b5bcc8484aa0f23e042b80c845b..11afecb9050ee3c993883a514c641674f5eb77ce 100644 (file)
@@ -31,8 +31,8 @@ Unless the B<CMS_REUSE_DIGEST> flag is set the returned CMS_ContentInfo
 structure is not complete and must be finalized either by streaming (if
 applicable) or a call to CMS_final().
 
-The CMS_SignerInfo_sign() function will explicitly sign a CMS_SignerInfo
-structure, its main use is when B<CMS_REUSE_DIGEST> and B<CMS_PARTIAL> flags
+The CMS_SignerInfo_sign() function explicitly signs a CMS_SignerInfo
+structure, its main use is when the B<CMS_REUSE_DIGEST> and B<CMS_PARTIAL> flags
 are both set.
 
 =head1 NOTES
@@ -90,6 +90,8 @@ before it is finalized.
 CMS_add1_signer() returns an internal pointer to the CMS_SignerInfo
 structure just added or NULL if an error occurs.
 
+CMS_SignerInfo_sign() returns 1 on success, 0 on failure.
+
 =head1 SEE ALSO
 
 L<ERR_get_error(3)>, L<CMS_sign(3)>,