linux-mips.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eric Biggers <ebiggers@kernel.org>
To: linux-crypto@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Ard Biesheuvel <ardb@kernel.org>,
	"Jason A . Donenfeld" <Jason@zx2c4.com>,
	linux-arm-kernel@lists.infradead.org, linux-mips@vger.kernel.org,
	linuxppc-dev@lists.ozlabs.org, linux-riscv@lists.infradead.org,
	linux-s390@vger.kernel.org, sparclinux@vger.kernel.org,
	x86@kernel.org, Eric Biggers <ebiggers@kernel.org>
Subject: [PATCH 06/18] lib/crypto: sha512: Fix a grammatical error in kerneldoc comments
Date: Wed, 25 Jun 2025 00:08:07 -0700	[thread overview]
Message-ID: <20250625070819.1496119-7-ebiggers@kernel.org> (raw)
In-Reply-To: <20250625070819.1496119-1-ebiggers@kernel.org>

"An HMAC", not "A HMAC".

Signed-off-by: Eric Biggers <ebiggers@kernel.org>
---
 include/crypto/sha2.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/include/crypto/sha2.h b/include/crypto/sha2.h
index 36a9dab805be7..296ce9d468bfc 100644
--- a/include/crypto/sha2.h
+++ b/include/crypto/sha2.h
@@ -247,11 +247,11 @@ struct hmac_sha384_ctx {
  */
 void hmac_sha384_preparekey(struct hmac_sha384_key *key,
 			    const u8 *raw_key, size_t raw_key_len);
 
 /**
- * hmac_sha384_init() - Initialize a HMAC-SHA384 context for a new message
+ * hmac_sha384_init() - Initialize an HMAC-SHA384 context for a new message
  * @ctx: (output) the HMAC context to initialize
  * @key: the prepared HMAC key
  *
  * If you don't need incremental computation, consider hmac_sha384() instead.
  *
@@ -262,11 +262,11 @@ static inline void hmac_sha384_init(struct hmac_sha384_ctx *ctx,
 {
 	__hmac_sha512_init(&ctx->ctx, &key->key);
 }
 
 /**
- * hmac_sha384_update() - Update a HMAC-SHA384 context with message data
+ * hmac_sha384_update() - Update an HMAC-SHA384 context with message data
  * @ctx: the HMAC context to update; must have been initialized
  * @data: the message data
  * @data_len: the data length in bytes
  *
  * This can be called any number of times.
@@ -278,11 +278,11 @@ static inline void hmac_sha384_update(struct hmac_sha384_ctx *ctx,
 {
 	__sha512_update(&ctx->ctx.sha_ctx, data, data_len);
 }
 
 /**
- * hmac_sha384_final() - Finish computing a HMAC-SHA384 value
+ * hmac_sha384_final() - Finish computing an HMAC-SHA384 value
  * @ctx: the HMAC context to finalize; must have been initialized
  * @out: (output) the resulting HMAC-SHA384 value
  *
  * After finishing, this zeroizes @ctx.  So the caller does not need to do it.
  *
@@ -405,11 +405,11 @@ struct hmac_sha512_ctx {
  */
 void hmac_sha512_preparekey(struct hmac_sha512_key *key,
 			    const u8 *raw_key, size_t raw_key_len);
 
 /**
- * hmac_sha512_init() - Initialize a HMAC-SHA512 context for a new message
+ * hmac_sha512_init() - Initialize an HMAC-SHA512 context for a new message
  * @ctx: (output) the HMAC context to initialize
  * @key: the prepared HMAC key
  *
  * If you don't need incremental computation, consider hmac_sha512() instead.
  *
@@ -420,11 +420,11 @@ static inline void hmac_sha512_init(struct hmac_sha512_ctx *ctx,
 {
 	__hmac_sha512_init(&ctx->ctx, &key->key);
 }
 
 /**
- * hmac_sha512_update() - Update a HMAC-SHA512 context with message data
+ * hmac_sha512_update() - Update an HMAC-SHA512 context with message data
  * @ctx: the HMAC context to update; must have been initialized
  * @data: the message data
  * @data_len: the data length in bytes
  *
  * This can be called any number of times.
@@ -436,11 +436,11 @@ static inline void hmac_sha512_update(struct hmac_sha512_ctx *ctx,
 {
 	__sha512_update(&ctx->ctx.sha_ctx, data, data_len);
 }
 
 /**
- * hmac_sha512_final() - Finish computing a HMAC-SHA512 value
+ * hmac_sha512_final() - Finish computing an HMAC-SHA512 value
  * @ctx: the HMAC context to finalize; must have been initialized
  * @out: (output) the resulting HMAC-SHA512 value
  *
  * After finishing, this zeroizes @ctx.  So the caller does not need to do it.
  *
-- 
2.50.0


  parent reply	other threads:[~2025-06-25  7:10 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-25  7:08 [PATCH 00/18] SHA-256 library improvements Eric Biggers
2025-06-25  7:08 ` [PATCH 01/18] libceph: Rename hmac_sha256() to ceph_hmac_sha256() Eric Biggers
2025-06-25  7:08 ` [PATCH 02/18] cxl/test: Simplify fw_buf_checksum_show() Eric Biggers
2025-06-25  7:08 ` [PATCH 03/18] crypto: sha512 - Use the correct legacy export format Eric Biggers
2025-06-25  7:08 ` [PATCH 04/18] lib/crypto: sha512: Reorder some code in sha512.c Eric Biggers
2025-06-25  7:08 ` [PATCH 05/18] lib/crypto: sha512: Do not include <crypto/internal/sha2.h> Eric Biggers
2025-06-25  7:08 ` Eric Biggers [this message]
2025-06-25  7:08 ` [PATCH 07/18] lib/crypto: sha256: Reorder some code Eric Biggers
2025-06-25  7:08 ` [PATCH 08/18] lib/crypto: sha256: Remove sha256_blocks_simd() Eric Biggers
2025-06-25  7:08 ` [PATCH 09/18] lib/crypto: sha256: Add sha224() and sha224_update() Eric Biggers
2025-06-25  7:08 ` [PATCH 10/18] lib/crypto: sha256: Make library API use strongly-typed contexts Eric Biggers
2025-06-25  7:08 ` [PATCH 11/18] lib/crypto: sha256: Propagate sha256_block_state type to implementations Eric Biggers
2025-06-25  7:08 ` [PATCH 12/18] lib/crypto: sha256: Add HMAC-SHA224 and HMAC-SHA256 support Eric Biggers
2025-06-25  7:08 ` [PATCH 13/18] crypto: sha256 - Wrap library and add HMAC support Eric Biggers
2025-06-25  7:08 ` [PATCH 14/18] crypto: sha256 - Use same state format as legacy drivers Eric Biggers
2025-06-25  7:08 ` [PATCH 15/18] lib/crypto: sha512: Remove sha256_is_arch_optimized() Eric Biggers
2025-06-25  7:08 ` [PATCH 16/18] lib/crypto: sha256: Consolidate into single module Eric Biggers
2025-06-25  7:08 ` [PATCH 17/18] lib/crypto: sha256: Sync sha256_update() with sha512_update() Eric Biggers
2025-06-25  7:08 ` [PATCH 18/18] lib/crypto: sha256: Document the SHA-224 and SHA-256 API Eric Biggers

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250625070819.1496119-7-ebiggers@kernel.org \
    --to=ebiggers@kernel.org \
    --cc=Jason@zx2c4.com \
    --cc=ardb@kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mips@vger.kernel.org \
    --cc=linux-riscv@lists.infradead.org \
    --cc=linux-s390@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=sparclinux@vger.kernel.org \
    --cc=x86@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).