Date: Mon, 3 Dec 2018 18:57:20 +0100 From: Benedict Reuschling <bcr@FreeBSD.org> To: Dirk Schroetter <dschroetter@gmail.com>, freebsd-doc@FreeBSD.org Subject: Re: Options, devices, hints - Documentation work needed ? Message-ID: <a0afc520-0dc8-81f9-d735-b332bd678707@FreeBSD.org> In-Reply-To: <D4193C67-A371-4D09-B7D5-C40CF0BCFD11@gmail.com> References: <D4193C67-A371-4D09-B7D5-C40CF0BCFD11@gmail.com>
next in thread | previous in thread | raw e-mail | index | archive | help
This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --QP1FNOW1PL8O9BwwL6vtJuIT5CXecrPO9 Content-Type: multipart/mixed; boundary="SFaD9LH97nTCkDMJxWXWCGqzc9QnoJ6tI"; protected-headers="v1" From: Benedict Reuschling <bcr@FreeBSD.org> To: Dirk Schroetter <dschroetter@gmail.com>, freebsd-doc@FreeBSD.org Message-ID: <a0afc520-0dc8-81f9-d735-b332bd678707@FreeBSD.org> Subject: Re: Options, devices, hints - Documentation work needed ? References: <D4193C67-A371-4D09-B7D5-C40CF0BCFD11@gmail.com> In-Reply-To: <D4193C67-A371-4D09-B7D5-C40CF0BCFD11@gmail.com> --SFaD9LH97nTCkDMJxWXWCGqzc9QnoJ6tI Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Hello Dirk, I think this is definitely valueable in multiple ways: - finding missing entries in NOTES or lacking a man page (as you noted) - adding cross references and notes to existing man pages (when appropria= te) - checking if all these options are needed or are included implicitly during kernel builds - identifying outdated information or obsolete entries Cross references will help developers understanding how things are interconnected within the kernel and the source tree. I'm just wondering what kind of format would be appropriate for the table. It could be a big table on the FreeBSD wiki, but it could also be part of the developers handbook or a separate article. Can you send us an excerpt so that we can see how it looks like? It does not have to be fancy, just to get a feel for the information in it. I could help out from the doc side of things and we should definitely find someone from the kernel side to confirm that the findings make sense= =2E Thanks! Cheers, Benedict Am 03.12.18 um 17:52 schrieb Dirk Schroetter: > Hello there, >=20 > 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. >=20 > So I did fire up the editor and managed to get a python script running = that looks at: >=20 > * The =E2=80=9Aoptions=E2=80=98 files under /usr/src > * The =E2=80=9ANOTES=E2=80=98 files > * The manual pages >=20 > all this being dumped into a table and cross-referenced. >=20 > 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 mention= ed on a man page (e.g. ACPI_MAX_TAKS or ADA_TEST_FAILURE) >=20 > 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: >=20 > 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. >=20 > It may be that this is a fool=E2=80=99s errand and much to big for a si= ngle person, but I would volunteer to at least get it started, if you fol= ks think that there is any merit to it. >=20 > So that would be my proposal and I would love to hear back from you. >=20 > Best Regards, >=20 > /Dirk > _______________________________________________ > freebsd-doc@freebsd.org mailing list > https://lists.freebsd.org/mailman/listinfo/freebsd-doc > To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org" >=20 --SFaD9LH97nTCkDMJxWXWCGqzc9QnoJ6tI-- --QP1FNOW1PL8O9BwwL6vtJuIT5CXecrPO9 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- iQEzBAEBCgAdFiEEwXonQDvNfP/33IoBVXQ7/QHhjTUFAlwFboAACgkQVXQ7/QHh jTVgEAf/TnC02kY+P1qYForeD2Aae19ToT4R/4h+TQ+xAWCHqJjoUj3WEc4Ua0UI QTy75ehqNsvxKJxLZYp0KPS3KoXxmKw+e9cGym27xKORAc3aF8iaX5DrQpgOCg0S LZuYnESsg+KHiFvvGkalpLaGPGAymyr2ISsZ4scCaV4xNr5ALC5a37WeHu/1QXIz 20bIgNcQEtjauyB76vJ7//4EXiZa7KgJKersMN+xv1JHWpUiPsHHj8mjFlC6FzBu 7EYZ2C6pGwVLBqOf3kEFOlJoNm3CwJN1mqoTBiXAnfDPLTbWe4tVdGDabka4Wr/x DgV1NmOsO6O2M68L+T7TYuMIZ3E6gg== =khO4 -----END PGP SIGNATURE----- --QP1FNOW1PL8O9BwwL6vtJuIT5CXecrPO9--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?a0afc520-0dc8-81f9-d735-b332bd678707>