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

[Eric Biggers]

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@xxxxxxxxxx>
> > 
> > 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