From: Dwaipayan Ray <dwaipayanray1@gmail.com>
To: joe@perches.com
Cc: lukas.bulwahn@gmail.com,
linux-kernel-mentees@lists.linuxfoundation.org,
linux-kernel@vger.kernel.org,
Dwaipayan Ray <dwaipayanray1@gmail.com>
Subject: [PATCH v6 0/2] checkpatch: add verbose mode
Date: Sun, 21 Feb 2021 17:28:00 +0530 [thread overview]
Message-ID: <20210221115802.19788-1-dwaipayanray1@gmail.com> (raw)
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.
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 | 526 +++++++++++++++++++++++++
Documentation/dev-tools/index.rst | 1 +
scripts/checkpatch.pl | 68 +++-
3 files changed, 592 insertions(+), 3 deletions(-)
create mode 100644 Documentation/dev-tools/checkpatch.rst
--
2.30.0
next reply other threads:[~2021-02-21 11:59 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-21 11:58 Dwaipayan Ray [this message]
2021-02-21 11:58 ` [PATCH v6 1/2] checkpatch: add verbose mode Dwaipayan Ray
2021-02-21 18:06 ` Joe Perches
2021-02-21 18:35 ` Dwaipayan Ray
2021-02-22 2:44 ` Joe Perches
2021-02-22 4:48 ` Dwaipayan Ray
2021-02-21 11:58 ` [PATCH v6 2/2] docs: add documentation for checkpatch 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=20210221115802.19788-1-dwaipayanray1@gmail.com \
--to=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
/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).