Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Tue, 25 Feb 2020 03:37:10 -0700
From:   Jonathan Corbet <corbet@lwn.net>
To:     Stephen Kitt <steve@sk2.org>
Cc:     Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3] docs: add a script to check sysctl docs
Message-ID: <20200225033710.312450f6@lwn.net>
In-Reply-To: <20200219153442.10205-1-steve@sk2.org>
References: <20200219153442.10205-1-steve@sk2.org>
Organization: LWN.net
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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