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@xxxxxxxxx> 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@xxxxxxxxxx
> 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