All of lore.kernel.org
 help / color / mirror / Atom feed
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>
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 0/2] docs & checkpatch: allow Closes tags with links
Date: Wed, 15 Mar 2023 18:44:55 +0100	[thread overview]
Message-ID: <20230314-doc-checkpatch-closes-tag-v1-0-1b83072e9a9a@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.

Because this tag is used for a bit of time by different subsystems and
it looks like it makes sense and it is useful for them, I didn't bother
Linus to get his permission to continue using it. If you think this is
necessary to do that up front, please tell me and I will be happy to ask
for his agreement.

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/

Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
---
Matthieu Baerts (2):
      docs: process: allow Closes tags with links
      checkpatch: allow Closes tags with links

 Documentation/process/5.Posting.rst          |  9 +++++++++
 Documentation/process/submitting-patches.rst |  7 +++++++
 scripts/checkpatch.pl                        | 16 ++++++++--------
 3 files changed, 24 insertions(+), 8 deletions(-)
---
base-commit: 6015b1aca1a233379625385feb01dd014aca60b5
change-id: 20230314-doc-checkpatch-closes-tag-1731b57556b1

Best regards,
-- 
Matthieu Baerts <matthieu.baerts@tessares.net>


WARNING: multiple messages have this Message-ID (diff)
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>
Cc: Matthieu Baerts <matthieu.baerts@tessares.net>,
	mptcp@lists.linux.dev, linux-kernel@vger.kernel.org,
	dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org
Subject: [PATCH 0/2] docs & checkpatch: allow Closes tags with links
Date: Wed, 15 Mar 2023 18:44:55 +0100	[thread overview]
Message-ID: <20230314-doc-checkpatch-closes-tag-v1-0-1b83072e9a9a@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.

Because this tag is used for a bit of time by different subsystems and
it looks like it makes sense and it is useful for them, I didn't bother
Linus to get his permission to continue using it. If you think this is
necessary to do that up front, please tell me and I will be happy to ask
for his agreement.

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/

Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
---
Matthieu Baerts (2):
      docs: process: allow Closes tags with links
      checkpatch: allow Closes tags with links

 Documentation/process/5.Posting.rst          |  9 +++++++++
 Documentation/process/submitting-patches.rst |  7 +++++++
 scripts/checkpatch.pl                        | 16 ++++++++--------
 3 files changed, 24 insertions(+), 8 deletions(-)
---
base-commit: 6015b1aca1a233379625385feb01dd014aca60b5
change-id: 20230314-doc-checkpatch-closes-tag-1731b57556b1

Best regards,
-- 
Matthieu Baerts <matthieu.baerts@tessares.net>


             reply	other threads:[~2023-03-15 17:45 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-15 17:44 Matthieu Baerts [this message]
2023-03-15 17:44 ` [PATCH 0/2] docs & checkpatch: allow Closes tags with links Matthieu Baerts
2023-03-15 17:44 ` [PATCH 1/2] docs: process: " Matthieu Baerts
2023-03-15 17:44   ` Matthieu Baerts
2023-03-15 18:12   ` Konstantin Ryabitsev
2023-03-15 18:12     ` Konstantin Ryabitsev
2023-03-15 18:29     ` Matthieu Baerts
2023-03-15 18:29       ` Matthieu Baerts
2023-03-15 18:19   ` Jonathan Corbet
2023-03-15 18:19     ` Jonathan Corbet
2023-03-15 18:28     ` Matthieu Baerts
2023-03-15 18:28       ` Matthieu Baerts
2023-03-15 19:12   ` Andrew Morton
2023-03-15 19:12     ` Andrew Morton
2023-03-17  8:00   ` Bagas Sanjaya
2023-03-17  8:00     ` Bagas Sanjaya
2023-03-20  9:07     ` Matthieu Baerts
2023-03-20  9:07       ` Matthieu Baerts
2023-03-15 17:44 ` [PATCH 2/2] checkpatch: " Matthieu Baerts
2023-03-15 17:44   ` Matthieu Baerts
2023-03-15 19:25   ` checkpatch: allow Closes tags with links: Tests Results MPTCP CI
2023-03-16  9:22 ` [PATCH 0/2] docs & checkpatch: allow Closes tags with links Thorsten Leemhuis
2023-03-16  9:22   ` Thorsten Leemhuis
2023-03-16 11:43   ` Matthieu Baerts
2023-03-16 11:43     ` Matthieu Baerts
2023-03-16 17:30     ` Linus Torvalds
2023-03-16 17:30       ` Linus Torvalds
2023-03-17 16:58       ` Daniel Vetter
2023-03-17 16:58         ` Daniel Vetter
2023-03-17 18:41         ` Matthieu Baerts
2023-03-17 18:41           ` Matthieu Baerts
2023-03-17 18:56           ` Konstantin Ryabitsev
2023-03-17 18:56             ` Konstantin Ryabitsev
2023-03-16 16:22   ` Konstantin Ryabitsev
2023-03-16 16:22     ` Konstantin Ryabitsev

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-v1-0-1b83072e9a9a@tessares.net \
    --to=matthieu.baerts@tessares.net \
    --cc=airlied@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=apw@canonical.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=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 \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.