From: Pauli <ppzgs1@gmail.com>
Date: Mon, 1 Mar 2021 23:05:15 +0000 (+1000)
Subject: doc: add params argument to key manager's gen_init call
X-Git-Tag: openssl-3.0.0-alpha14~331
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c4c422e0ccd2d72c22f3787570d075f56f089298;p=thirdparty%2Fopenssl.git

doc: add params argument to key manager's gen_init call

Fixes #14286

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14383)
---

diff --git a/doc/man7/provider-keymgmt.pod b/doc/man7/provider-keymgmt.pod
index 2156ed9b7fd..aba7e3a8841 100644
--- a/doc/man7/provider-keymgmt.pod
+++ b/doc/man7/provider-keymgmt.pod
@@ -19,7 +19,8 @@ provider-keymgmt - The KEYMGMT library E<lt>-E<gt> provider functions
  void OSSL_FUNC_keymgmt_free(void *keydata);
 
  /* Generation, a more complex constructor */
- void *OSSL_FUNC_keymgmt_gen_init(void *provctx, int selection);
+ void *OSSL_FUNC_keymgmt_gen_init(void *provctx, int selection,
+                                  const OSSL_PARAM params[]);
  int OSSL_FUNC_keymgmt_gen_set_template(void *genctx, void *template);
  int OSSL_FUNC_keymgmt_gen_set_params(void *genctx, const OSSL_PARAM params[]);
  const OSSL_PARAM *OSSL_FUNC_keymgmt_gen_settable_params(void *genctx,
@@ -221,7 +222,8 @@ more elaborate context based key object constructor.
 
 OSSL_FUNC_keymgmt_gen_init() should create the key object generation context
 and initialize it with I<selections>, which will determine what kind
-of contents the key object to be generated should get.
+of contents the key object to be generated should get.  The I<params>, if
+not NULL, should be set on the generation context.
 
 OSSL_FUNC_keymgmt_gen_set_template() should add I<template> to the context
 I<genctx>.  The I<template> is assumed to be a key object constructed