[PATCH v8 0/3] checkpatch: add verbose mode

Dwaipayan Ray dwaipayanray1 at gmail.com
Fri Feb 26 09:38:24 UTC 2021


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

-- 
2.30.0



More information about the Linux-kernel-mentees mailing list