From: Dr. David von Oheimb <dev@ddvo.net>
Date: Mon, 14 Apr 2025 19:09:16 +0000 (+0200)
Subject: OSSL_CALLBACK.pod: add missing info on required return values of callback functions
X-Git-Tag: openssl-3.6.0-beta1~12
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=56f67a6d618d2d738d5c15d5b2e1ca046431ddf1;p=thirdparty%2Fopenssl.git

OSSL_CALLBACK.pod: add missing info on required return values of callback functions

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/28474)

(cherry picked from commit 1875bb0fecf6584cfe62dc5c454648e50a9ad281)
---

diff --git a/doc/man3/OSSL_CALLBACK.pod b/doc/man3/OSSL_CALLBACK.pod
index 5fa8a8f0891..c0ffad53c99 100644
--- a/doc/man3/OSSL_CALLBACK.pod
+++ b/doc/man3/OSSL_CALLBACK.pod
@@ -47,15 +47,10 @@ Additional parameters can be passed with the L<OSSL_PARAM(3)> array I<params>,
 
 =back
 
-=begin comment RETURN VALUES doesn't make sense for a manual that only
-describes a type, but document checkers still want that section, and
-to have more than just the section title.
-
 =head1 RETURN VALUES
 
-txt
-
-=end comment
+Functions of type B<OSSL_CALLBACK> and B<OSSL_PASSPHRASE_CALLBACK>
+must return 1 on success and 0 on failure.
 
 =head1 SEE ALSO