Document prototype change and return values for BIO_set_cipher()
authortb <tb@openbsd.org>
Fri, 24 Aug 2018 19:32:26 +0000 (19:32 +0000)
committertb <tb@openbsd.org>
Fri, 24 Aug 2018 19:32:26 +0000 (19:32 +0000)
ok jsing

lib/libcrypto/man/BIO_f_cipher.3

index 9a74d4c..ccd3746 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: BIO_f_cipher.3,v 1.10 2018/05/02 16:04:35 schwarze Exp $
+.\"    $OpenBSD: BIO_f_cipher.3,v 1.11 2018/08/24 19:32:26 tb Exp $
 .\"    OpenSSL 186bb907 Apr 13 11:05:13 2015 -0700
 .\"
 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -49,7 +49,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: May 2 2018 $
+.Dd $Mdocdate: August 24 2018 $
 .Dt BIO_F_CIPHER 3
 .Os
 .Sh NAME
@@ -65,7 +65,7 @@
 .Fo BIO_f_cipher
 .Fa void
 .Fc
-.Ft void
+.Ft int
 .Fo BIO_set_cipher
 .Fa "BIO *b"
 .Fa "const EVP_CIPHER *cipher"
@@ -154,6 +154,8 @@ by preceding the cipher BIO with a buffering BIO.
 .Sh RETURN VALUES
 .Fn BIO_f_cipher
 returns the cipher BIO method.
+.Fn BIO_set_cipher
+returns 1 on success and 0 on error.
 .Pp
 .Fn BIO_get_cipher_status
 returns 1 for a successful decrypt and 0 for failure.