summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorShane Lontis <shane.lontis@oracle.com>2021-04-28 17:51:15 +1000
committerShane Lontis <shane.lontis@oracle.com>2021-04-30 16:04:53 +1000
commit455f2542526ba3aa0db16dc8c4a5289d7f3e6b50 (patch)
treee9ece2797bfc891ce3219bdb9d42293836c32bfd /doc
parent857c223bf73f6d3ec91567cf341c5267392a3e66 (diff)
Update OSSL_STORE_attach() documentation to indicate it increases the ref_count of the passed in bio
Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/15058)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/OSSL_STORE_attach.pod5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/man3/OSSL_STORE_attach.pod b/doc/man3/OSSL_STORE_attach.pod
index 87910e434e..9ad53af81a 100644
--- a/doc/man3/OSSL_STORE_attach.pod
+++ b/doc/man3/OSSL_STORE_attach.pod
@@ -18,7 +18,8 @@ OSSL_STORE_attach - Functions to read objects from a BIO
OSSL_STORE_attach() works like L<OSSL_STORE_open(3)>, except it takes a B<BIO>
I<bio> instead of a I<uri>, along with a I<scheme> to determine what loader
-should be used to process the data.
+should be used to process the data. The reference count of the B<BIO> object
+is increased by 1 if the call is successful.
=head1 RETURN VALUES
@@ -35,7 +36,7 @@ OSSL_STORE_attach() was added in OpenSSL 3.0.
=head1 COPYRIGHT
-Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy