[PATCH] scripts/checkpatch.pl: check for non-permalinks to Zulip

[PATCH] scripts/checkpatch.pl: check for non-permalinks to Zulip

[Siddharth Menon]

Zulip links to https://rust-for-linux.zulipchat.com can break in
case of renaming the topic or channel if they are not a message
links (which are permalinks).

If a non-permanent zulip link is referenced emit a warning and
directs to the zulip documentation.

permanent links are of the format:
https://.../#narrow/stream/x/topic/x/near/<numerical_id>

Reported-by: ojeda@kernel.org
Closes: https://github.com/Rust-for-Linux/linux/issues/110
Signed-off-by: Siddharth Menon <simeddon@gmail.com>
---
 scripts/checkpatch.pl | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 39032224d504..a4fb4e724f75 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -735,6 +735,10 @@ our $obsolete_archives = qr{(?xi:
 	\Qspinics.net\E
 )};
 
+our $zulip_forums = qr{(?xi:
+	\Qrust-for-linux.zulipchat.com\E
+)};
+
 our @typeListMisordered = (
 	qr{char\s+(?:un)?signed},
 	qr{int\s+(?:(?:un)?signed\s+)?short\s},
@@ -3415,6 +3419,12 @@ sub process {
 			     "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr);
 		}
 
+# Check for permanent Zulip URL
+		if ($rawline =~ m{http.*\b$zulip_forums(?!(?:/#narrow/stream/.+/topic/.+/(?:near|with)/\d+)?($|\s+.*))}) {
+			WARN("PREFER_PERMANENT_URL",
+			     "Use permanent Zulip links when possible - see https://chat.zulip.org/api/construct-narrow#narrows-that-use-ids\n" . $herecurr);
+		}
+
 # Check for added, moved or deleted files
 		if (!$reported_maintainer_file && !$in_commit_log &&
 		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
-- 
2.39.2

Re: [PATCH] scripts/checkpatch.pl: check for non-permalinks to Zulip

[Joe Perches]

On 2024-08-25 15:18, Siddharth Menon wrote:
> Zulip links to https://rust-for-linux.zulipchat.com can break in
> case of renaming the topic or channel if they are not a message
> links (which are permalinks).

Why should these links be used in the kernel at all?

Re: [PATCH] scripts/checkpatch.pl: check for non-permalinks to Zulip

[BiscuitBobby]

On Sun, 2024-08-25 at 15:23 -0700, Joe Perches wrote:
> On 2024-08-25 15:18, Siddharth Menon wrote:
> > Zulip links to https://rust-for-linux.zulipchat.com can break in
> > case of renaming the topic or channel if they are not a message
> > links (which are permalinks).
> 
> Why should these links be used in the kernel at all?

To my understanding, most of the discussion around the 
development of the Rust subsystem takes place here, and is
frequently referenced in the mailing list.

Re: [PATCH] scripts/checkpatch.pl: check for non-permalinks to Zulip

[Miguel Ojeda]

On Mon, Aug 26, 2024 at 12:33 AM Joe Perches <joe@perches.com> wrote:
>
> Why should these links be used in the kernel at all?

They should probably not be used in files, but we put them in commit
messages from time to time, e.g. for `Closes:` or `Link:` tags.

Cheers,
Miguel

Re: [PATCH] scripts/checkpatch.pl: check for non-permalinks to Zulip

[Miguel Ojeda]

On Mon, Aug 26, 2024 at 12:18 AM Siddharth Menon <simeddon@gmail.com> wrote:
>
> Zulip links to https://rust-for-linux.zulipchat.com can break in
> case of renaming the topic or channel if they are not a message
> links (which are permalinks).

a message -> message

> If a non-permanent zulip link is referenced emit a warning and
> directs to the zulip documentation.

emit -> , then emit
directs -> direct the user
zulip -> Zulip

> permanent links are of the format:
> https://.../#narrow/stream/x/topic/x/near/<numerical_id>

permanent -> Permanent

> Reported-by: ojeda@kernel.org
> Closes: https://github.com/Rust-for-Linux/linux/issues/110

Sorry, I copy-pasted a template we use for "good first issues" and I
should have not mentioned these two tags, because it is not a bug.
They should be `Suggested-by` and `Link` instead. Also, please use the
standard format "Full Name <email>".

In addition, the link should be to #1104, not #110, i.e.
https://github.com/Rust-for-Linux/linux/issues/1104

> +                            "Use permanent Zulip links when possible - see https://chat.zulip.org/api/construct-narrow#narrows-that-use-ids\n" . $herecurr);

Hmm... That link seems a bit too technical.

Perhaps it would be easiest to give an example here (like in the
commit message) if there are no better docs about this.

Thanks!

Cheers,
Miguel