linux-kernel - Re: [PATCH] rust: convert raw URLs to Markdown autolinks in comments

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: <CANiq72m55Fi-XyFz=h7_3QNj+mA0N+E9Vo2_anLFyN1sr-FXMA@mail.gmail.com>
Date: Sun, 6 Apr 2025 12:27:53 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Xizhe Yin <xizheyin@...il.nju.edu.cn>
Cc: rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org, 
	Miguel Ojeda <ojeda@...nel.org>
Subject: Re: [PATCH] rust: convert raw URLs to Markdown autolinks in comments

On Sun, Apr 6, 2025 at 5:51 AM Xizhe Yin <xizheyin@...il.nju.edu.cn> wrote:
>
> From: xizheyin <xizheyin@...il.nju.edu.cn>

This should ideally match your Signed-off-by.

> Some comments in Rust files use raw URLs (http://example.com) rather
> than Markdown autolinks [text](URL). This inconsistency makes the
> documentation less uniform and harder to maintain.
>
> This patch converts all remaining raw URLs in Rust code comments to use
> the Markdown autolink format, maintaining consistency with the rest of
> the codebase which already uses this style.
>
> Link: Rust-for-Linux#1153
> Suggested-by: Miguel Ojeda <ojeda@...nel.org>

I am really a newbie on the Markdown spec, but as far as I can tell,
Markdown autolinks are the `<...>` ones:

    https://spec.commonmark.org/0.31.2/#autolinks

So what I was trying to suggest adding a few missing `<>` to a few raw
URLs we have.

By the way, the "Link" should be a full URL to the issue here :)

Thanks  for the patch!

Cheers,
Miguel