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

[Benno Lossin]

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@xxxxxxxxxxx>
> Reported-by: FUJITA Tomonori <fujita.tomonori@xxxxxxxxx>
> Closes: https://lore.kernel.org/r/20231026.204058.2167744626131849993.fujita.tomonori@xxxxxxxxx [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@xxxxxxxxxx>

This is nice.

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

-- 
Cheers,
Benno