Re: [PATCH v3] docs: add a script to check sysctl docs

From: Jonathan Corbet
Date: Tue Feb 25 2020 - 05:37:18 EST


On Wed, 19 Feb 2020 16:34:42 +0100
Stephen Kitt <steve@xxxxxxx> wrote:

> This script allows sysctl documentation to be checked against the
> kernel source code, to identify missing or obsolete entries. Running
> it against 5.5 shows for example that sysctl/kernel.rst has two
> obsolete entries and is missing 52 entries.
>
> Signed-off-by: Stephen Kitt <steve@xxxxxxx>
> ---
> Changes since v2:
> * drop UTF-8 characters
> * fix license identifier
> * fix example invocation to include path as well as table
>
> v2 was the initial submission (in v2 of the sysctl/kernel.rst patch
> set).

This seems like a useful thing to have, so I've applied it. It would be
rather more useful, though, with a bit of ... wait for it ...
documentation. Even just an example command line in the header comments
would be a good place to start. Care to send a followup? :)

Thanks,

jon