From: Abdellah Ouhbi <abdououhbi1@gmail.com>
To: herbert@gondor.apana.org.au, davem@davemloft.net
Cc: linux-crypto@vger.kernel.org, linux-kernel@vger.kernel.org,
skhan@linuxfoundation.org, me@brighamcampbell.com,
Abdellah Ouhbi <abdououhbi1@gmail.com>
Subject: [PATCH] crypto:scompress: fix kernel-doc warning and spelling error
Date: Sat, 14 Mar 2026 20:16:08 +0000 [thread overview]
Message-ID: <20260314201610.212712-1-abdououhbi1@gmail.com> (raw)
Fix htmldocs build warning:
./include/crypto/internal/scompress.h:39 struct member
'COMP_ALG_COMMON' not described in 'scomp_alg'
The struct scomp_alg contains an anonymous union member defined by
macro COMP_ALG_COMMON that was not documented. Add documentation
following the pattern used in other crypto headers for similar
anonymous members.
Also fix spelling error in existing comment: "Cmonn" to "Common".
Signed-off-by: Abdellah Ouhbi <abdououhbi1@gmail.com>
---
include/crypto/internal/scompress.h | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/include/crypto/internal/scompress.h b/include/crypto/internal/scompress.h
index 6a2c5f2e90f9..f91a2c3487ef 100644
--- a/include/crypto/internal/scompress.h
+++ b/include/crypto/internal/scompress.h
@@ -21,7 +21,8 @@ struct crypto_scomp {
* @compress: Function performs a compress operation
* @decompress: Function performs a de-compress operation
* @streams: Per-cpu memory for algorithm
- * @calg: Cmonn algorithm data structure shared with acomp
+ * @calg: Common algorithm data structure shared with acomp
+ * @COMP_ALG_COMMON: see struct comp_alg_common in crypto/acompress.h
*/
struct scomp_alg {
int (*compress)(struct crypto_scomp *tfm, const u8 *src,
--
2.51.0
next reply other threads:[~2026-03-14 20:16 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-14 20:16 Abdellah Ouhbi [this message]
-- strict thread matches above, loose matches on Subject: below --
2026-03-12 18:00 [PATCH] crypto:scompress: fix kernel-doc warning and spelling error Abdellah Ouhbi
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=20260314201610.212712-1-abdououhbi1@gmail.com \
--to=abdououhbi1@gmail.com \
--cc=davem@davemloft.net \
--cc=herbert@gondor.apana.org.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=me@brighamcampbell.com \
--cc=skhan@linuxfoundation.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