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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CANiq72ns_Awo3HD+P-hHrAOHQemRirtp3Zvei9OYgfLf8eWncw@mail.gmail.com>
Date: Mon, 26 Aug 2024 22:03:37 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Siddharth Menon <simeddon@...il.com>
Cc: rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org, 
	linux-kernel-mentees@...ts.linuxfoundation.org, apw@...onical.com, 
	joe@...ches.com, ojeda@...nel.org
Subject: Re: [PATCH] scripts/checkpatch.pl: check for non-permalinks to Zulip

On Mon, Aug 26, 2024 at 12:18 AM Siddharth Menon <simeddon@...il.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@...nel.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