diff mbox series

[6/7] lib/crc: document all the CRC library kconfig options

Message ID 20250401221600.24878-7-ebiggers@kernel.org (mailing list archive)
State Not Applicable
Delegated to: Herbert Xu
Headers show
Series More CRC kconfig option cleanups | expand

Commit Message

Eric Biggers April 1, 2025, 10:15 p.m. UTC 
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(+)

Comments

Christoph Hellwig April 4, 2025, 8:37 a.m. UTC | #1 
On Tue, Apr 01, 2025 at 03:15:59PM -0700, Eric Biggers wrote:
> 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.

I usually document hidden options using comments instead of the help
text to clearly distinguish them for visible options.  Not sure if there
is a general preference either way, I just through I'd drop this here.
Eric Biggers April 4, 2025, 7:02 p.m. UTC | #2 
On Fri, Apr 04, 2025 at 01:37:17AM -0700, Christoph Hellwig wrote:
> On Tue, Apr 01, 2025 at 03:15:59PM -0700, Eric Biggers wrote:
> > 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.
> 
> I usually document hidden options using comments instead of the help
> text to clearly distinguish them for visible options.  Not sure if there
> is a general preference either way, I just through I'd drop this here.

Using comments makes sense to me.  But on past patches affecting hidden options,
I've had people ask for help text specifically.  It also looks like help text is
more common than comments, even considering just hidden options.  So I think
I'll keep this patch as-is.

- Eric
diff mbox series

Patch

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