From: Matt Caswell <matt@openssl.org>
Date: Thu, 14 Oct 2021 16:04:16 +0000 (+0100)
Subject: Fix the signature newctx documentation
X-Git-Tag: openssl-3.2.0-alpha1~3463
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5fdc95e443b4d62a3d1f7094ae6d6ae4682b77e0;p=thirdparty%2Fopenssl.git

Fix the signature newctx documentation

The documentation omitted the propq parameter

Fixes #16755

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16836)
---

diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod
index a299d43cc56..9d4df86fd65 100644
--- a/doc/man7/provider-signature.pod
+++ b/doc/man7/provider-signature.pod
@@ -18,7 +18,7 @@ provider-signature - The signature library E<lt>-E<gt> provider functions
   */
 
  /* Context management */
- void *OSSL_FUNC_signature_newctx(void *provctx);
+ void *OSSL_FUNC_signature_newctx(void *provctx, const char *propq);
  void OSSL_FUNC_signature_freectx(void *ctx);
  void *OSSL_FUNC_signature_dupctx(void *ctx);
 
@@ -104,7 +104,7 @@ function pointer from an B<OSSL_DISPATCH> element named
 B<OSSL_FUNC_{name}>.
 For example, the "function" OSSL_FUNC_signature_newctx() has these:
 
- typedef void *(OSSL_FUNC_signature_newctx_fn)(void *provctx);
+ typedef void *(OSSL_FUNC_signature_newctx_fn)(void *provctx, const char *propq);
  static ossl_inline OSSL_FUNC_signature_newctx_fn
      OSSL_FUNC_signature_newctx(const OSSL_DISPATCH *opf);
 
@@ -183,7 +183,9 @@ structure for holding context information during a signature operation.
 A pointer to this context will be passed back in a number of the other signature
 operation function calls.
 The parameter I<provctx> is the provider context generated during provider
-initialisation (see L<provider(7)>).
+initialisation (see L<provider(7)>). The I<propq> parameter is a property query
+string that may be (optionally) used by the provider during any "fetches" that
+it may perform (if it performs any).
 
 OSSL_FUNC_signature_freectx() is passed a pointer to the provider side signature
 context in the I<ctx> parameter.