Re: [PATCH] rust: sync: arc: use intra-doc links for `Arc` in doc comments

Miguel Ojeda <[email protected]>
Newsgroups org.kernel.vger.rust-for-linux,org.kernel.vger.linux-kernel
Message-ID <CANiq72mWPXALRLxcNsME3FjMRZXhw=qJZCr0VtKqMbJfUz0JAA@mail.gmail.com>
On Fri, Jul 3, 2026 at 1:21 PM Vasileios Almpanis
<[email protected]> wrote:
>
> Two doc comments on `Arc`'s raw-pointer methods referred to the type as
> plain text rather than as an intra-doc link like the rest of the file:
>
>   - `as_ptr` said "this arc", lowercase and unlinked;
>   - `into_raw` said "this Arc object", capitalized but still not linked.
>
> Rewrite both to use the `[`Arc`]` intra-doc link, matching the style used
> everywhere else in the file and making the references clickable in the
> generated documentation. No functional change.
>
> Suggested-by: Miguel Ojeda <[email protected]>
> Link: https://github.com/Rust-for-Linux/linux/issues/1240
> Signed-off-by: Vasileios Almpanis <[email protected]>

Thanks for the patch & welcome! We ended up applying:

  https://lore.kernel.org/rust-for-linux/[email protected]/

since it improved more cases, but otherwise the patch itself looked
good, i.e. procedurally it was fine, so please do more! :)

(I considered picking this one and then modifying the other one on
top, but it seemed a bit verbose to have two commits in the log for
this kind of cleanup)

Cheers,
Miguel
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.