Options, devices, hints - Documentation work needed ?

[Dirk Schroetter]

Hello there,

I am just working on my kernel and its config and after trying to find a comprehensive list of kernel options, I came up short.

So I did fire up the editor and managed to get a python script running that looks at:

* The ‚options‘ files under /usr/src
* The ‚NOTES‘ files
* The manual pages

all this being dumped into a table and cross-referenced.

My current stat on a FreeBSD 11.2 AMD64: Around 1000 kernel options of which around half do not have either an entry in NOTES or are not mentioned on a man page (e.g. ACPI_MAX_TAKS or ADA_TEST_FAILURE)

So I was going to try to compile some form of documentation for all of these for my own personal use. Then I was wondering if the Documentation project had any use for this kind of information. My idea was:

1. Try to get the information into the respective NOTES files.
2. Make sure the options, devices, hints get into the option.h files
3. Updating the man pages.

It may be that this is a fool’s errand and much to big for a single person, but I would volunteer to at least get it started, if you folks think that there is any merit to it.

So that would be my proposal and I would love to hear back from you.

Best Regards,

/Dirk