diff mbox series

crypto : asymmetric_keys: Fix function description to match prototype

Message ID 20211006172350.1025091-1-colin.king@canonical.com (mailing list archive)
State New
Headers show
Series crypto : asymmetric_keys: Fix function description to match prototype | expand

Commit Message

Colin King Oct. 6, 2021, 5:23 p.m. UTC
From: Colin Ian King <colin.king@canonical.com>

The function arguments in the description does not match the prototype.
Fix this by renaming trust_keys to trusted_keys.

Signed-off-by: Colin Ian King <colin.king@canonical.com>
---
 crypto/asymmetric_keys/verify_pefile.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Ben Boeckel Oct. 6, 2021, 5:41 p.m. UTC | #1
On Wed, Oct 06, 2021 at 18:23:50 +0100, Colin King wrote:
> From: Colin Ian King <colin.king@canonical.com>
> 
> The function arguments in the description does not match the prototype.
> Fix this by renaming trust_keys to trusted_keys.
> 
> Signed-off-by: Colin Ian King <colin.king@canonical.com>
> ---
>  crypto/asymmetric_keys/verify_pefile.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/crypto/asymmetric_keys/verify_pefile.c b/crypto/asymmetric_keys/verify_pefile.c
> index 7553ab18db89..148cad70fe79 100644
> --- a/crypto/asymmetric_keys/verify_pefile.c
> +++ b/crypto/asymmetric_keys/verify_pefile.c
> @@ -387,7 +387,7 @@ static int pefile_digest_pe(const void *pebuf, unsigned int pelen,
>   * verify_pefile_signature - Verify the signature on a PE binary image
>   * @pebuf: Buffer containing the PE binary image
>   * @pelen: Length of the binary image
> - * @trust_keys: Signing certificate(s) to use as starting points
> + * @trusted_keys: Signing certificate(s) to use as starting points
>   * @usage: The use to which the key is being put.
>   *
>   * Validate that the certificate chain inside the PKCS#7 message inside the PE

FYI, this was submitted earlier this week with Message-Id:

    20211004001731.26240-1-rdunlap@infradead.org

which also fixes the `Return:` notation for the return value docs.

--Ben
Randy Dunlap Oct. 6, 2021, 5:45 p.m. UTC | #2
On 10/6/21 10:23 AM, Colin King wrote:
> From: Colin Ian King <colin.king@canonical.com>
> 
> The function arguments in the description does not match the prototype.
> Fix this by renaming trust_keys to trusted_keys.
> 
> Signed-off-by: Colin Ian King <colin.king@canonical.com>
> ---
>   crypto/asymmetric_keys/verify_pefile.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/crypto/asymmetric_keys/verify_pefile.c b/crypto/asymmetric_keys/verify_pefile.c
> index 7553ab18db89..148cad70fe79 100644
> --- a/crypto/asymmetric_keys/verify_pefile.c
> +++ b/crypto/asymmetric_keys/verify_pefile.c
> @@ -387,7 +387,7 @@ static int pefile_digest_pe(const void *pebuf, unsigned int pelen,
>    * verify_pefile_signature - Verify the signature on a PE binary image
>    * @pebuf: Buffer containing the PE binary image
>    * @pelen: Length of the binary image
> - * @trust_keys: Signing certificate(s) to use as starting points
> + * @trusted_keys: Signing certificate(s) to use as starting points
>    * @usage: The use to which the key is being put.
>    *
>    * Validate that the certificate chain inside the PKCS#7 message inside the PE
> 

or this one (which I have sent 2x):
https://lore.kernel.org/all/20211004001731.26240-1-rdunlap@infradead.org/
diff mbox series

Patch

diff --git a/crypto/asymmetric_keys/verify_pefile.c b/crypto/asymmetric_keys/verify_pefile.c
index 7553ab18db89..148cad70fe79 100644
--- a/crypto/asymmetric_keys/verify_pefile.c
+++ b/crypto/asymmetric_keys/verify_pefile.c
@@ -387,7 +387,7 @@  static int pefile_digest_pe(const void *pebuf, unsigned int pelen,
  * verify_pefile_signature - Verify the signature on a PE binary image
  * @pebuf: Buffer containing the PE binary image
  * @pelen: Length of the binary image
- * @trust_keys: Signing certificate(s) to use as starting points
+ * @trusted_keys: Signing certificate(s) to use as starting points
  * @usage: The use to which the key is being put.
  *
  * Validate that the certificate chain inside the PKCS#7 message inside the PE