linux-arch.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eric Biggers <ebiggers@kernel.org>
To: linux-kernel@vger.kernel.org
Cc: Ard Biesheuvel <ardb@kernel.org>,
	linux-crypto@vger.kernel.org, linux-arch@vger.kernel.org
Subject: [PATCH 6/7] lib/crc: document all the CRC library kconfig options
Date: Tue,  1 Apr 2025 15:15:59 -0700	[thread overview]
Message-ID: <20250401221600.24878-7-ebiggers@kernel.org> (raw)
In-Reply-To: <20250401221600.24878-1-ebiggers@kernel.org>

From: Eric Biggers <ebiggers@google.com>

Previous commits removed all the original CRC kconfig help text, since
it was oriented towards people configuring the kernel, and the options
are no longer user-selectable.  However, it's still useful for there to
be help text for kernel developers.  Add this.

Signed-off-by: Eric Biggers <ebiggers@google.com>
---
 lib/Kconfig | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/lib/Kconfig b/lib/Kconfig
index 89470bb24519..4e796eaea2f4 100644
--- a/lib/Kconfig
+++ b/lib/Kconfig
@@ -138,63 +138,90 @@ config TRACE_MMIO_ACCESS
 
 source "lib/crypto/Kconfig"
 
 config CRC_CCITT
 	tristate
+	help
+	  The CRC-CCITT library functions.  Select this if your module uses any
+	  of the functions from <linux/crc-ccitt.h>.
 
 config CRC16
 	tristate
+	help
+	  The CRC16 library functions.  Select this if your module uses any of
+	  the functions from <linux/crc16.h>.
 
 config CRC_T10DIF
 	tristate
+	help
+	  The CRC-T10DIF library functions.  Select this if your module uses
+	  any of the functions from <linux/crc-t10dif.h>.
 
 config ARCH_HAS_CRC_T10DIF
 	bool
 
 config CRC_T10DIF_ARCH
 	tristate
 	default CRC_T10DIF if ARCH_HAS_CRC_T10DIF && CRC_OPTIMIZATIONS
 
 config CRC_ITU_T
 	tristate
+	help
+	  The CRC-ITU-T library functions.  Select this if your module uses
+	  any of the functions from <linux/crc-itu-t.h>.
 
 config CRC32
 	tristate
 	select BITREVERSE
+	help
+	  The CRC32 library functions.  Select this if your module uses any of
+	  the functions from <linux/crc32.h> or <linux/crc32c.h>.
 
 config ARCH_HAS_CRC32
 	bool
 
 config CRC32_ARCH
 	tristate
 	default CRC32 if ARCH_HAS_CRC32 && CRC_OPTIMIZATIONS
 
 config CRC64
 	tristate
+	help
+	  The CRC64 library functions.  Select this if your module uses any of
+	  the functions from <linux/crc64.h>.
 
 config ARCH_HAS_CRC64
 	bool
 
 config CRC64_ARCH
 	tristate
 	default CRC64 if ARCH_HAS_CRC64 && CRC_OPTIMIZATIONS
 
 config CRC4
 	tristate
+	help
+	  The CRC4 library functions.  Select this if your module uses any of
+	  the functions from <linux/crc4.h>.
 
 config CRC7
 	tristate
+	help
+	  The CRC7 library functions.  Select this if your module uses any of
+	  the functions from <linux/crc7.h>.
 
 config LIBCRC32C
 	tristate
 	select CRC32
 	help
 	  This option just selects CRC32 and is provided for compatibility
 	  purposes until the users are updated to select CRC32 directly.
 
 config CRC8
 	tristate
+	help
+	  The CRC8 library functions.  Select this if your module uses any of
+	  the functions from <linux/crc8.h>.
 
 config CRC_OPTIMIZATIONS
 	bool "Enable optimized CRC implementations" if EXPERT
 	default y
 	help
-- 
2.49.0


  parent reply	other threads:[~2025-04-01 22:16 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-01 22:15 [PATCH 0/7] More CRC kconfig option cleanups Eric Biggers
2025-04-01 22:15 ` [PATCH 1/7] lib/crc: remove unnecessary prompt for CONFIG_CRC32 and drop 'default y' Eric Biggers
2025-04-02  3:42   ` Randy Dunlap
2025-04-02  3:51     ` Eric Biggers
2025-04-02  4:50       ` Randy Dunlap
2025-04-02  5:02         ` Eric Biggers
2025-04-02  5:56           ` Randy Dunlap
2025-04-02 16:41             ` Eric Biggers
2025-04-04  8:36             ` Christoph Hellwig
2025-04-01 22:15 ` [PATCH 2/7] lib/crc: remove unnecessary prompt for CONFIG_CRC_CCITT Eric Biggers
2025-04-01 22:15 ` [PATCH 3/7] lib/crc: remove unnecessary prompt for CONFIG_CRC16 Eric Biggers
2025-04-01 22:15 ` [PATCH 4/7] lib/crc: remove unnecessary prompt for CONFIG_CRC_T10DIF Eric Biggers
2025-04-01 22:15 ` [PATCH 5/7] lib/crc: remove unnecessary prompt for CONFIG_CRC_ITU_T Eric Biggers
2025-04-01 22:15 ` Eric Biggers [this message]
2025-04-04  8:37   ` [PATCH 6/7] lib/crc: document all the CRC library kconfig options Christoph Hellwig
2025-04-04 19:02     ` Eric Biggers
2025-04-01 22:16 ` [PATCH 7/7] lib/crc: remove CONFIG_LIBCRC32C Eric Biggers
2025-04-02  6:47 ` [PATCH 0/7] More CRC kconfig option cleanups Ard Biesheuvel
2025-04-02 13:52 ` Martin K. Petersen
2025-04-04  8:37 ` Christoph Hellwig

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=20250401221600.24878-7-ebiggers@kernel.org \
    --to=ebiggers@kernel.org \
    --cc=ardb@kernel.org \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-kernel@vger.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).