From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: Joe Perches <joe@perches.com>,
linux-kernel-mentees@lists.linuxfoundation.org,
linux-kernel <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH v7 0/2] checkpatch: add verbose mode
Date: Thu, 25 Feb 2021 21:55:01 +0100 [thread overview]
Message-ID: <20210225215501.2408c97b@coco.lan> (raw)
In-Reply-To: <CABJPP5AARO3h2mt-piPWuOD3kY_XzNfW-s2mi=btfOayVPURHg@mail.gmail.com>
Em Thu, 25 Feb 2021 23:38:03 +0530
Dwaipayan Ray <dwaipayanray1@gmail.com> escreveu:
> On Thu, Feb 25, 2021 at 11:03 PM Joe Perches <joe@perches.com> 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.
Thanks,
Mauro
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2021-02-25 20:55 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-22 7:52 [Linux-kernel-mentees] [PATCH v7 0/2] checkpatch: add verbose mode Dwaipayan Ray
2021-02-22 7:52 ` [Linux-kernel-mentees] [PATCH v7 1/2] " Dwaipayan Ray
2021-02-22 7:52 ` [Linux-kernel-mentees] [PATCH v7 2/2] docs: add documentation for checkpatch Dwaipayan Ray
2021-02-25 17:33 ` [PATCH v7 0/2] checkpatch: add verbose mode Joe Perches
2021-02-25 18:08 ` Dwaipayan Ray
2021-02-25 20:55 ` Mauro Carvalho Chehab [this message]
2021-02-26 10:50 ` Joe Perches
2021-02-25 21:16 ` Jonathan Corbet
2021-02-26 8:53 ` Dwaipayan Ray
2021-02-26 5:59 ` Lukas Bulwahn
2021-02-26 9:20 ` Dwaipayan Ray
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210225215501.2408c97b@coco.lan \
--to=mchehab@kernel.org \
--cc=corbet@lwn.net \
--cc=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).