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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200225033710.312450f6@lwn.net>
Date:   Tue, 25 Feb 2020 03:37:10 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Stephen Kitt <steve@....org>
Cc:     Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3] docs: add a script to check sysctl docs

On Wed, 19 Feb 2020 16:34:42 +0100
Stephen Kitt <steve@....org> 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@....org>
> ---
> 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