Commit 8a155d34d9 for openssl.org
commit 8a155d34d98b1b889add6adabd47e5729c8025b3
Author: Theodore DellaVilla <tdellavi@outlook.com>
Date: Fri Oct 23 12:14:55 2026 -0400
Document that OSSL_PARAM_BLD keys are stored by reference
The key string passed to the OSSL_PARAM_BLD_push functions is not
duplicated, so it must outlive the OSSL_PARAM array returned by
OSSL_PARAM_BLD_to_param().
Fixes #33264
CLA: trivial
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
Merge-date: Tue Oct 27 08:55:03 2026
Merged-from: https://github.com/openssl/openssl/pull/33362
diff --git a/doc/man3/OSSL_PARAM_BLD.pod b/doc/man3/OSSL_PARAM_BLD.pod
index 2f107ec750..593fb7bf6c 100644
--- a/doc/man3/OSSL_PARAM_BLD.pod
+++ b/doc/man3/OSSL_PARAM_BLD.pod
@@ -62,6 +62,12 @@ OSSL_PARAM_free(); if the contents of OSSL_PARAM array are confidential call
OSSL_PARAM_clear_free().
OSSL_PARAM_BLD_free() can safely be called any time after this function is.
+For all of the OSSL_PARAM_BLD_push functions, the I<key> string is stored
+by reference and is not copied.
+It must be a static string or otherwise remain allocated and unmodified
+until the OSSL_PARAM array returned by OSSL_PARAM_BLD_to_param() has been
+freed.
+
=begin comment
POD is pretty good at recognising function names and making them appropriately