Clarify documentation of SSL_SESSION_dup
authorWatson Ladd <watsonbladd@gmail.com>
Thu, 27 Apr 2023 17:16:49 +0000 (10:16 -0700)
committerTomas Mraz <tomas@openssl.org>
Fri, 12 May 2023 08:24:16 +0000 (10:24 +0200)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Todd Short <todd.short@me.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20848)

(cherry picked from commit 25bab273ccc9b517cc4c1783950e3f95421cb570)

doc/man3/SSL_SESSION_free.pod

index 74c6ec2a29cb5bc343b8726c8d05a9da46fad5cd..33475d76b6a6917e46a3fc9f21ce859d5011e875 100644 (file)
@@ -21,8 +21,8 @@ SSL_SESSION_free - create, free and manage SSL_SESSION structures
 SSL_SESSION_new() creates a new SSL_SESSION structure and returns a pointer to
 it.
 
-SSL_SESSION_dup() copies the contents of the SSL_SESSION structure in B<src>
-and returns a pointer to it.
+SSL_SESSION_dup() creates a new SSL_SESSION structure that is a copy of B<src>.
+The copy is not owned by any cache that B<src> may have been in.
 
 SSL_SESSION_up_ref() increments the reference count on the given SSL_SESSION
 structure.
@@ -62,6 +62,8 @@ incorrect reference counts and therefore program failures.
 SSL_SESSION_new returns a pointer to the newly allocated SSL_SESSION structure
 or NULL on error.
 
+SSL_SESSION_dup returns a pointer to the new copy or NULL on error.
+
 SSL_SESSION_up_ref returns 1 on success or 0 on error.
 
 =head1 SEE ALSO