From: Matthieu Baerts <matthieu.baerts@tessares.net>
To: "Jonathan Corbet" <corbet@lwn.net>,
"Andy Whitcroft" <apw@canonical.com>,
"Joe Perches" <joe@perches.com>,
"Dwaipayan Ray" <dwaipayanray1@gmail.com>,
"Lukas Bulwahn" <lukas.bulwahn@gmail.com>,
"Kai Wasserbäch" <kai@dev.carbon-project.org>,
"Thorsten Leemhuis" <linux@leemhuis.info>,
"Andrew Morton" <akpm@linux-foundation.org>,
"David Airlie" <airlied@gmail.com>,
"Daniel Vetter" <daniel@ffwll.ch>,
"Konstantin Ryabitsev" <konstantin@linuxfoundation.org>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Linus Torvalds" <torvalds@linux-foundation.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
dri-devel@lists.freedesktop.org, mptcp@lists.linux.dev,
Matthieu Baerts <matthieu.baerts@tessares.net>
Subject: [PATCH v4 0/5] docs & checkpatch: allow Closes tags with links
Date: Mon, 03 Apr 2023 18:23:45 +0200 [thread overview]
Message-ID: <20230314-doc-checkpatch-closes-tag-v4-0-d26d1fa66f9f@tessares.net> (raw)
Since v6.3, checkpatch.pl now complains about the use of "Closes:" tags
followed by a link [1]. It also complains if a "Reported-by:" tag is
followed by a "Closes:" one [2].
As detailed in the first patch, this "Closes:" tag is used for a bit of
time, mainly by DRM and MPTCP subsystems. It is used by some bug
trackers to automate the closure of issues when a patch is accepted.
It is even planned to use this tag with bugzilla.kernel.org [3].
The first patch updates the documentation to explain what is this
"Closes:" tag and how/when to use it. The second patch modifies
checkpatch.pl to stop complaining about it.
The DRM maintainers and their mailing list have been added in Cc as they
are probably interested by these two patches as well.
[1] https://lore.kernel.org/all/3b036087d80b8c0e07a46a1dbaaf4ad0d018f8d5.1674217480.git.linux@leemhuis.info/
[2] https://lore.kernel.org/all/bb5dfd55ea2026303ab2296f4a6df3da7dd64006.1674217480.git.linux@leemhuis.info/
[3] https://lore.kernel.org/linux-doc/20230315181205.f3av7h6owqzzw64p@meerkat.local/
Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
---
Note: After having re-read the comments from the v1, it is still unclear
to me if this "Closes:" can be accepted or not. But because it seems
that the future Bugzilla bot for kernel.org and regzbot would like to
use it as well, I'm sending here new versions. I'm sorry if I
misunderstood the comments from v1. Please tell me if I did.
Changes in v4:
- Patches 1/5, 3/5 and 4/5 have been added to ask using the "Closes" tag
instead of the "Link" one for any bug reports. (Thorsten)
- The Fixes tags have been removed from patch 4/5. (Joe)
- The "Reported-by being followed by a link tag" check is now only
looking for the tag, not the URL which is done elsewhere in patch 5/5.
(Thorsten)
- A new patch has been added to fix a small issues in checkpatch.pl when
checking if "Reported-by:" tag is on the last line.
- Link to v3: https://lore.kernel.org/r/20230314-doc-checkpatch-closes-tag-v3-0-d1bdcf31c71c@tessares.net
Changes in v3:
- Patch 1/4 now allow using the "Closes" tag with any kind of bug
reports, as long as the link is public. (Thorsten)
- The former patch 2/2 has been split in two: first to use a list for
the different "link" tags (Joe). Then to allow the 'Closes' tag.
- A new patch has been added to let checkpatch.pl checking if "Closes"
and "Links" are used with a URL.
- Link to v2: https://lore.kernel.org/r/20230314-doc-checkpatch-closes-tag-v2-0-f4a417861f6d@tessares.net
Changes in v2:
- The text on patch 1/2 has been reworked thanks to Jon, Bagas and
Thorsten. See the individual changelog on the patch for more details.
- Private bug trackers and invalid URLs are clearly marked as forbidden
to avoid being misused. (Linus)
- Rebased on top of Linus' repo.
- Link to v1: https://lore.kernel.org/r/20230314-doc-checkpatch-closes-tag-v1-0-1b83072e9a9a@tessares.net
---
Matthieu Baerts (5):
docs: process: allow Closes tags with links
checkpatch: don't print the next line if not defined
checkpatch: use a list of "link" tags
checkpatch: allow Closes tags with links
checkpatch: check for misuse of the link tags
Documentation/process/5.Posting.rst | 22 ++++++++++----
Documentation/process/submitting-patches.rst | 26 +++++++++++------
scripts/checkpatch.pl | 43 ++++++++++++++++++++++------
3 files changed, 70 insertions(+), 21 deletions(-)
---
base-commit: 7e364e56293bb98cae1b55fd835f5991c4e96e7d
change-id: 20230314-doc-checkpatch-closes-tag-1731b57556b1
Best regards,
--
Matthieu Baerts <matthieu.baerts@tessares.net>
next reply other threads:[~2023-04-03 16:24 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-03 16:23 Matthieu Baerts [this message]
2023-04-03 16:23 ` [PATCH v4 1/5] docs: process: allow Closes tags with links Matthieu Baerts
2023-04-04 8:09 ` Thorsten Leemhuis
2023-04-04 8:42 ` Matthieu Baerts
2023-04-03 16:23 ` [PATCH v4 2/5] checkpatch: don't print the next line if not defined Matthieu Baerts
2023-04-03 16:23 ` [PATCH v4 3/5] checkpatch: use a list of "link" tags Matthieu Baerts
2023-04-03 16:23 ` [PATCH v4 4/5] checkpatch: allow Closes tags with links Matthieu Baerts
2023-04-03 16:23 ` [PATCH v4 5/5] checkpatch: check for misuse of the link tags Matthieu Baerts
2023-04-03 16:44 ` [PATCH v4 0/5] docs & checkpatch: allow Closes tags with links Joe Perches
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=20230314-doc-checkpatch-closes-tag-v4-0-d26d1fa66f9f@tessares.net \
--to=matthieu.baerts@tessares.net \
--cc=airlied@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=apw@canonical.com \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=kai@dev.carbon-project.org \
--cc=konstantin@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=lukas.bulwahn@gmail.com \
--cc=mptcp@lists.linux.dev \
--cc=torvalds@linux-foundation.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).