Misc fix ups to deprecate explicit de-init documentation

[openssl.git] / doc / crypto / BIO_new.pod

diff --git a/doc/crypto/BIO_new.pod b/doc/crypto/BIO_new.pod
index 2a245fc8de83e962aec0153cf22a872199144c66..4c9299bb3c1a55c0b2f154fed3feba2cec963815 100644 (file)
--- a/doc/crypto/BIO_new.pod
+++ b/doc/crypto/BIO_new.pod
@@ -2,14 +2,15 @@
 
 =head1 NAME
 
-BIO_new, BIO_set, BIO_free, BIO_vfree, BIO_free_all - BIO allocation and freeing functions
+BIO_new, BIO_set, BIO_up_ref, BIO_free, BIO_vfree, BIO_free_all - BIO allocation and freeing functions
 
 =head1 SYNOPSIS
 
  #include <openssl/bio.h>
 
- BIO * BIO_new(BIO_METHOD *type);
- int   BIO_set(BIO *a,BIO_METHOD *type);
+ BIO * BIO_new(const BIO_METHOD *type);
+ int   BIO_set(BIO *a,const BIO_METHOD *type);
+ int   BIO_up_ref(BIO *a);
  int   BIO_free(BIO *a);
  void  BIO_vfree(BIO *a);
  void  BIO_free_all(BIO *a);
@@ -20,20 +21,25 @@ The BIO_new() function returns a new BIO using method B<type>.
 
 BIO_set() sets the method of an already existing BIO.
 
+BIO_up_ref() increments the reference count associated with the BIO object.
+
 BIO_free() frees up a single BIO, BIO_vfree() also frees up a single BIO
-but it does not return a value. Calling BIO_free() may also have some effect
+but it does not return a value.
+If B<a> is NULL nothing is done.
+Calling BIO_free() may also have some effect
 on the underlying I/O structure, for example it may close the file being
 referred to under certain circumstances. For more details see the individual
 BIO_METHOD descriptions.
 
 BIO_free_all() frees up an entire BIO chain, it does not halt if an error
 occurs freeing up an individual BIO in the chain.
+If B<a> is NULL nothing is done.
 
 =head1 RETURN VALUES
 
 BIO_new() returns a newly created BIO or NULL if the call fails.
 
-BIO_set(), BIO_free() return 1 for success and 0 for failure.
+BIO_set(), BIO_up_ref() and BIO_free() return 1 for success and 0 for failure.
 
 BIO_free_all() and BIO_vfree() do not return values.