Skip to content

Commit 31ab49a

Browse files
committed
lib/crc: document all the CRC library kconfig options
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. Reviewed-by: Christoph Hellwig <hch@lst.de> Reviewed-by: "Martin K. Petersen" <martin.petersen@oracle.com> Acked-by: Ard Biesheuvel <ardb@kernel.org> Link: https://lore.kernel.org/r/20250401221600.24878-7-ebiggers@kernel.org Signed-off-by: Eric Biggers <ebiggers@google.com>
1 parent a0d55dd commit 31ab49a

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

lib/Kconfig

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,21 @@ source "lib/crypto/Kconfig"
140140

141141
config CRC_CCITT
142142
tristate
143+
help
144+
The CRC-CCITT library functions. Select this if your module uses any
145+
of the functions from <linux/crc-ccitt.h>.
143146

144147
config CRC16
145148
tristate
149+
help
150+
The CRC16 library functions. Select this if your module uses any of
151+
the functions from <linux/crc16.h>.
146152

147153
config CRC_T10DIF
148154
tristate
155+
help
156+
The CRC-T10DIF library functions. Select this if your module uses
157+
any of the functions from <linux/crc-t10dif.h>.
149158

150159
config ARCH_HAS_CRC_T10DIF
151160
bool
@@ -156,10 +165,16 @@ config CRC_T10DIF_ARCH
156165

157166
config CRC_ITU_T
158167
tristate
168+
help
169+
The CRC-ITU-T library functions. Select this if your module uses
170+
any of the functions from <linux/crc-itu-t.h>.
159171

160172
config CRC32
161173
tristate
162174
select BITREVERSE
175+
help
176+
The CRC32 library functions. Select this if your module uses any of
177+
the functions from <linux/crc32.h> or <linux/crc32c.h>.
163178

164179
config ARCH_HAS_CRC32
165180
bool
@@ -170,6 +185,9 @@ config CRC32_ARCH
170185

171186
config CRC64
172187
tristate
188+
help
189+
The CRC64 library functions. Select this if your module uses any of
190+
the functions from <linux/crc64.h>.
173191

174192
config ARCH_HAS_CRC64
175193
bool
@@ -180,9 +198,15 @@ config CRC64_ARCH
180198

181199
config CRC4
182200
tristate
201+
help
202+
The CRC4 library functions. Select this if your module uses any of
203+
the functions from <linux/crc4.h>.
183204

184205
config CRC7
185206
tristate
207+
help
208+
The CRC7 library functions. Select this if your module uses any of
209+
the functions from <linux/crc7.h>.
186210

187211
config LIBCRC32C
188212
tristate
@@ -193,6 +217,9 @@ config LIBCRC32C
193217

194218
config CRC8
195219
tristate
220+
help
221+
The CRC8 library functions. Select this if your module uses any of
222+
the functions from <linux/crc8.h>.
196223

197224
config CRC_OPTIMIZATIONS
198225
bool "Enable optimized CRC implementations" if EXPERT

0 commit comments

Comments
 (0)