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 283F4C433DB for ; Wed, 27 Jan 2021 13:10:15 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id D3A61207B0 for ; Wed, 27 Jan 2021 13:10:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1343523AbhA0NJ4 (ORCPT ); Wed, 27 Jan 2021 08:09:56 -0500 Received: from smtprelay0219.hostedemail.com ([216.40.44.219]:36404 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S313748AbhAZWpG (ORCPT ); Tue, 26 Jan 2021 17:45:06 -0500 Received: from filter.hostedemail.com (clb03-v110.bra.tucows.net [216.40.38.60]) by smtprelay01.hostedemail.com (Postfix) with ESMTP id 50796100E7B43; Tue, 26 Jan 2021 22:44:22 +0000 (UTC) X-Session-Marker: 6A6F6540706572636865732E636F6D X-HE-Tag: dolls97_4f0dac027592 X-Filterd-Recvd-Size: 2959 Received: from [192.168.1.159] (unknown [47.151.137.21]) (Authenticated sender: joe@perches.com) by omf14.hostedemail.com (Postfix) with ESMTPA; Tue, 26 Jan 2021 22:44:21 +0000 (UTC) Message-ID: Subject: Re: [PATCH RFC 1/3] checkpatch: add verbose mode From: Joe Perches To: Dwaipayan Ray Cc: linux-kernel-mentees@lists.linuxfoundation.org, Lukas Bulwahn , linux-kernel Date: Tue, 26 Jan 2021 14:44:20 -0800 In-Reply-To: References: <20210126183521.26535-1-dwaipayanray1@gmail.com> <20210126183521.26535-2-dwaipayanray1@gmail.com> <9bfc9c21d93bb55419954114ed3a7e5cbdc84ddb.camel@perches.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 Wed, 2021-01-27 at 01:57 +0530, Dwaipayan Ray wrote: > On Wed, Jan 27, 2021 at 1:41 AM Joe Perches wrote: > > On Wed, 2021-01-27 at 00:05 +0530, Dwaipayan Ray wrote: > > > Add a new verbose mode to checkpatch.pl to emit additional verbose > > > test descriptions. > > > > > > The verbose mode is optional and can be enabled by the flag > > > --verbose. [] > > > Documentation/dev-tools/checkpatch.rst: > > > > > > .. CHECKPATCH_START > > > > Nak on the keyword uses. > > > > This should really just parse the input file whenever TYPE is found > > via some fixed format and save the verbose description after that. > > > > Use .rst Field Lists instead, and ideally, keep the list in alphabetic > > order or group by similar use. > > > > https://docutils.sourceforge.io/docs/user/rst/quickref.html#field-lists > > > > e.g.: > > > > :LINE_SPACING: > >         Vertical space is wasted given the limited number of lines an > >         editor window can display when multiple blank lines are used. > > > > :SPACING: > >         Whitespace style used in the kernel sources is described in > >         ref:`Documentation/process/Coding-Style.rst section 3.1. > > > > :TRAILING_WHITESPACE: > >         Trailing whitespace should always be removed. > >         Some editors highlight the trailing whitespace and cause visual > >         distractions when editing files. > > > > etc... [] > for the output part can we do something to make the text > look a bit more nice? I think some of the verbose descriptions > can go a bit long. Which is why verbose should be optional. > Also will the verbose descriptions be limited to say single > paragraphs? Ideally, no. > If there are multiple paragraphs then the output > does appear a bit messy. I fail to see how that's a problem but play with it and see what you can do.