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=-8.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED autolearn=ham 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 A3A68C433E0 for ; Thu, 25 Feb 2021 17:34:52 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 5638164F21 for ; Thu, 25 Feb 2021 17:34:52 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230386AbhBYRed (ORCPT ); Thu, 25 Feb 2021 12:34:33 -0500 Received: from smtprelay0086.hostedemail.com ([216.40.44.86]:37152 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S229548AbhBYRe2 (ORCPT ); Thu, 25 Feb 2021 12:34:28 -0500 Received: from filter.hostedemail.com (clb03-v110.bra.tucows.net [216.40.38.60]) by smtprelay07.hostedemail.com (Postfix) with ESMTP id A1E62180364DB; Thu, 25 Feb 2021 17:33:42 +0000 (UTC) X-Session-Marker: 6A6F6540706572636865732E636F6D X-HE-Tag: view71_120217127693 X-Filterd-Recvd-Size: 3052 Received: from [192.168.1.159] (unknown [47.151.137.21]) (Authenticated sender: joe@perches.com) by omf08.hostedemail.com (Postfix) with ESMTPA; Thu, 25 Feb 2021 17:33:41 +0000 (UTC) Message-ID: Subject: Re: [PATCH v7 0/2] checkpatch: add verbose mode From: Joe Perches To: Dwaipayan Ray , Jonathan Corbet , Mauro Carvalho Chehab Cc: lukas.bulwahn@gmail.com, linux-kernel-mentees@lists.linuxfoundation.org, linux-kernel@vger.kernel.org Date: Thu, 25 Feb 2021 09:33:40 -0800 In-Reply-To: <20210222075205.19834-1-dwaipayanray1@gmail.com> References: <20210222075205.19834-1-dwaipayanray1@gmail.com> 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 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? Ideally, the patch order would be reversed so the .rst file is added first, then checkpatch updated to use it. And _a lot_ more types and descriptive content should be added. > > Changes in v7: > - Add color coding support to --list-types option > > Changes in v6: > - Allow using verbose mode with --list-types option > > Changes in v5: > - Change the reference format to use absolute links. > - Print verbose descriptions only for the first time >   a message type is encountered. > > Changes in v4: > - Change the type description format > - Group the message types by usage > - Make handling of --terse with --verbose simpler > > Changes in v3: > - Simplify documentation file parsing in checkpatch > - Document a total of 33 message types for checkpatch > > Changes in v2: > - Use .rst Field Lists to specify the type descriptions. > - Add a few more type descriptions to documentation. > > Dwaipayan Ray (2): >   checkpatch: add verbose mode >   docs: add documentation for checkpatch > >  Documentation/dev-tools/checkpatch.rst | 525 +++++++++++++++++++++++++ >  Documentation/dev-tools/index.rst | 1 + >  scripts/checkpatch.pl | 133 ++++++- >  3 files changed, 639 insertions(+), 20 deletions(-) >  create mode 100644 Documentation/dev-tools/checkpatch.rst >