Re: [PATCH] rust: sync: arc: use intra-doc links for `Arc` in doc comments
From: Miguel Ojeda
Date: Sat Aug 15 2026 - 11:12:20 EST
On Fri, Jul 3, 2026 at 1:21 PM Vasileios Almpanis
<vasilisalmpanis@xxxxxxxxx> 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 <ojeda@xxxxxxxxxx>
> Link: https://github.com/Rust-for-Linux/linux/issues/1240
> Signed-off-by: Vasileios Almpanis <vasilisalmpanis@xxxxxxxxx>
Thanks for the patch & welcome! We ended up applying:
https://lore.kernel.org/rust-for-linux/20260711144721.39185-1-harish.cs.ss24@xxxxxxxxx/
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