From: Shane Lontis <shane.lontis@oracle.com>
Date: Wed, 28 Apr 2021 07:51:15 +0000 (+1000)
Subject: Update OSSL_STORE_attach() documentation to indicate it increases the ref_count of... 
X-Git-Tag: openssl-3.0.0-alpha16~74
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=455f2542526ba3aa0db16dc8c4a5289d7f3e6b50;p=thirdparty%2Fopenssl.git

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)
---

diff --git a/doc/man3/OSSL_STORE_attach.pod b/doc/man3/OSSL_STORE_attach.pod
index 87910e434e0..9ad53af81a8 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