linux-kernel - Re: [PATCH] rust: support `srctree`-relative links

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] [thread-next>] [day] [month] [year] [list]

Date: Mon, 18 Dec 2023 16:47:42 +0000
From: Benno Lossin <benno.lossin@...ton.me>
To: Miguel Ojeda <ojeda@...nel.org>, Wedson Almeida Filho <wedsonaf@...il.com>, Alex Gaynor <alex.gaynor@...il.com>
Cc: Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>, Björn Roy Baron <bjorn3_gh@...tonmail.com>, Andreas Hindborg <a.hindborg@...sung.com>, Alice Ryhl <aliceryhl@...gle.com>, rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org, patches@...ts.linux.dev, FUJITA Tomonori <fujita.tomonori@...il.com>
Subject: Re: [PATCH] rust: support `srctree`-relative links

On 12/16/23 00:54, Miguel Ojeda wrote:
> Some of our links use relative paths in order to point to files in the
> source tree, e.g.:
> 
>     //! C header: [`include/linux/printk.h`](../../../../include/linux/printk.h)
>     /// [`struct mutex`]: ../../../../include/linux/mutex.h
> 
> These are problematic because they are hard to maintain and do not support
> `O=` builds.
> 
> Instead, provide support for `srctree`-relative links, e.g.:
> 
>     //! C header: [`include/linux/printk.h`](srctree/include/linux/printk.h)
>     /// [`struct mutex`]: srctree/include/linux/mutex.h
> 
> The links are fixed after `rustdoc` generation to be based on the absolute
> path to the source tree.
> 
> Essentially, this is the automatic version of Tomonori's fix [1],
> suggested by Gary [2].
> 
> Suggested-by: Gary Guo <gary@...yguo.net>
> Reported-by: FUJITA Tomonori <fujita.tomonori@...il.com>
> Closes: https://lore.kernel.org/r/20231026.204058.2167744626131849993.fujita.tomonori@gmail.com [1]
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Link: https://lore.kernel.org/rust-for-linux/20231026154525.6d14b495@eugeo/ [2]
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>

This is nice.

Reviewed-by: Benno Lossin <benno.lossin@...ton.me>

-- 
Cheers,
Benno