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=-3.7 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=no 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 AB73EC433E0 for ; Fri, 26 Feb 2021 10:51:28 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4A9B864EEE for ; Fri, 26 Feb 2021 10:51:28 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230413AbhBZKvB (ORCPT ); Fri, 26 Feb 2021 05:51:01 -0500 Received: from smtprelay0060.hostedemail.com ([216.40.44.60]:33516 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S230223AbhBZKu7 (ORCPT ); Fri, 26 Feb 2021 05:50:59 -0500 Received: from filter.hostedemail.com (clb03-v110.bra.tucows.net [216.40.38.60]) by smtprelay02.hostedemail.com (Postfix) with ESMTP id 05A37AF8C; Fri, 26 Feb 2021 10:50:17 +0000 (UTC) X-Session-Marker: 6A6F6540706572636865732E636F6D X-HE-Tag: dime75_4c077ac27699 X-Filterd-Recvd-Size: 3638 Received: from [192.168.1.159] (unknown [47.151.137.21]) (Authenticated sender: joe@perches.com) by omf17.hostedemail.com (Postfix) with ESMTPA; Fri, 26 Feb 2021 10:50:15 +0000 (UTC) Message-ID: Subject: Re: [PATCH v7 0/2] checkpatch: add verbose mode From: Joe Perches To: Mauro Carvalho Chehab , Dwaipayan Ray Cc: Jonathan Corbet , Lukas Bulwahn , linux-kernel-mentees@lists.linuxfoundation.org, linux-kernel Date: Fri, 26 Feb 2021 02:50:14 -0800 In-Reply-To: <20210225215501.2408c97b@coco.lan> References: <20210222075205.19834-1-dwaipayanray1@gmail.com> <20210225215501.2408c97b@coco.lan> Content-Type: text/plain; charset="ISO-8859-1" User-Agent: Evolution 3.38.1-1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, 2021-02-25 at 21:55 +0100, Mauro Carvalho Chehab wrote: > Em Thu, 25 Feb 2021 23:38:03 +0530 > Dwaipayan Ray escreveu: > > > On Thu, Feb 25, 2021 at 11:03 PM Joe Perches wrote: > > > > > > On Mon, 2021-02-22 at 13:22 +0530, Dwaipayan Ray wrote: > > > > Add a new verbose mode to checkpatch. The verbose test > > > > descriptions are read from the checkpatch documentation > > > > file at `Documentation/dev-tools/checkpatch.rst`. > > > > > > > > The verbose mode is optional and can be enabled by the > > > > flag -v or --verbose. > > > > > > > > The documentation file is only parsed by checkpatch.pl > > > > if the verbose mode is enabled. The verbose mode can > > > > not be used together with the --terse option. > > > > > > I don't have any real objection to this patch set, but as this > > > might be added to the Documentation tree and in .rst format, > > > perhaps Jonathan Corbet and/or Mauro Carvalho Chehab might have > > > some opinion. > > > > > > Also I do not want to be a maintainer of this .rst file and > > > likely neither Jon nor Mauro would either. Perhaps you? > > >   > > > > > > > I could take it up if everybody is okay with it! > > > > > Ideally, the patch order would be reversed so the .rst file > > > is added first, then checkpatch updated to use it. > > >   > > > > > > > Sure, if Jonathan or Mauro has no objections to it, I will be happy > > to resend it so that it can be picked up properly. > > I don't have any objections, provided that I won't be maintaining > it :-) > > - > > Just my two cents: > > IMO, maintaining this on a separate file can be a maintenance nightmare, > as this is the kind of thing that can become obsolete real soon. > > One alternative would be to use Pod::Usage module, just like > this script does: > > scripts/get_abi.pl > > with something similar to that, calling > > $ checkpatch --man > > Could generate a man-page style with all options, while: > > $ checkpatch --help > > would print the current help page. > > Yet, this would generate more work for Joe, as, for every new > type, the corresponding help text would be needed. Does this get integrated into the .rst output? I see: Documentation/Makefile:$(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI) But no obvious mechanism that emits .rst files for Pod::Usage And no, I'm not much interested in maintaining those docs either.