From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.3 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_2 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2695AC35DF9 for ; Tue, 25 Feb 2020 10:37:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 052F421744 for ; Tue, 25 Feb 2020 10:37:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730126AbgBYKhR (ORCPT ); Tue, 25 Feb 2020 05:37:17 -0500 Received: from ms.lwn.net ([45.79.88.28]:53220 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730033AbgBYKhR (ORCPT ); Tue, 25 Feb 2020 05:37:17 -0500 Received: from localhost.localdomain (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id D9D486D9; Tue, 25 Feb 2020 10:37:15 +0000 (UTC) Date: Tue, 25 Feb 2020 03:37:10 -0700 From: Jonathan Corbet To: Stephen Kitt Cc: Mauro Carvalho Chehab , 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 X-Mailer: Claws Mail 3.17.4 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Wed, 19 Feb 2020 16:34:42 +0100 Stephen Kitt 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 > --- > 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