Messages in this thread | | | From | Dwaipayan Ray <> | Date | Thu, 25 Feb 2021 23:38:03 +0530 | Subject | Re: [PATCH v7 0/2] checkpatch: add verbose mode |
| |
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.
> And _a lot_ more types and descriptive content should be added.
Yes that's for sure. If this makes it I will try to get all of the other types in. And if Lukas agrees, a little help from my fellow kernel mentees will be nice as well!
With warm regards, Dwaipayan.
> > > > 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 > > > >
| |