[v8,0/3] checkpatch: add verbose mode
mbox series

Message ID 20210226093827.12700-1-dwaipayanray1@gmail.com
Headers show
Series
  • checkpatch: add verbose mode
Related show

Message

Dwaipayan Ray Feb. 26, 2021, 9:38 a.m. UTC
Add a new verbose mode to checkpatch. The verbose test
descriptions are read from the new checkpatch documentation
file at `Documentation/dev-tools/checkpatch.rst`, which
is also added by this series.

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.

Changes in v8:
- Remove custom table of contents from checkpatch rst

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):
  docs: add documentation for checkpatch
  checkpatch: add verbose mode

Lukas Bulwahn (1):
  MAINTAINERS: clarify responsibility for checkpatch documentation

 Documentation/dev-tools/checkpatch.rst | 513 +++++++++++++++++++++++++
 Documentation/dev-tools/index.rst      |   1 +
 MAINTAINERS                            |   9 +
 scripts/checkpatch.pl                  | 133 ++++++-
 4 files changed, 636 insertions(+), 20 deletions(-)
 create mode 100644 Documentation/dev-tools/checkpatch.rst

Comments

Jonathan Corbet March 1, 2021, 9:22 p.m. UTC | #1
Dwaipayan Ray <dwaipayanray1@gmail.com> writes:

> Add a new verbose mode to checkpatch. The verbose test
> descriptions are read from the new checkpatch documentation
> file at `Documentation/dev-tools/checkpatch.rst`, which
> is also added by this series.

So I can certainly take the doc change, as requested.  Remind me,
though...should I apply the whole set, or will the checkpatch changes go
via another path?

Thanks,

jon
Joe Perches March 1, 2021, 9:53 p.m. UTC | #2
On Mon, 2021-03-01 at 14:22 -0700, Jonathan Corbet wrote:
> Dwaipayan Ray <dwaipayanray1@gmail.com> writes:
> 
> > Add a new verbose mode to checkpatch. The verbose test
> > descriptions are read from the new checkpatch documentation
> > file at `Documentation/dev-tools/checkpatch.rst`, which
> > is also added by this series.
> 
> So I can certainly take the doc change, as requested.  Remind me,
> though...should I apply the whole set, or will the checkpatch changes go
> via another path?

There's no dedicated upstream path for checkpatch.
So please take the checkpatch changes too.
Jonathan Corbet March 1, 2021, 9:57 p.m. UTC | #3
Joe Perches <joe@perches.com> writes:

> On Mon, 2021-03-01 at 14:22 -0700, Jonathan Corbet wrote:
>> Dwaipayan Ray <dwaipayanray1@gmail.com> writes:
>> 
>> > Add a new verbose mode to checkpatch. The verbose test
>> > descriptions are read from the new checkpatch documentation
>> > file at `Documentation/dev-tools/checkpatch.rst`, which
>> > is also added by this series.
>> 
>> So I can certainly take the doc change, as requested.  Remind me,
>> though...should I apply the whole set, or will the checkpatch changes go
>> via another path?
>
> There's no dedicated upstream path for checkpatch.
> So please take the checkpatch changes too.

OK, I have just done that.

Thanks,

jon