rust: support `srctree`-relative links
authorMiguel Ojeda <ojeda@kernel.org>
Fri, 15 Dec 2023 23:54:28 +0000 (00:54 +0100)
committerMiguel Ojeda <ojeda@kernel.org>
Thu, 21 Dec 2023 19:54:17 +0000 (20:54 +0100)
commitbc2e7d5c298a86f2aa759cabe46f66f862fca3b3
tree8808aa7ca0e5c80becee53385f0f3528715dd6b9
parent0a7f5ba73e57eaf7f2e5589d26bbe9bf6754c542
rust: support `srctree`-relative links

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@garyguo.net>
Reported-by: FUJITA Tomonori <fujita.tomonori@gmail.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/
Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/r/20231215235428.243211-1-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
12 files changed:
Documentation/rust/coding-guidelines.rst
rust/Makefile
rust/kernel/error.rs
rust/kernel/ioctl.rs
rust/kernel/kunit.rs
rust/kernel/print.rs
rust/kernel/sync/condvar.rs
rust/kernel/sync/lock/mutex.rs
rust/kernel/sync/lock/spinlock.rs
rust/kernel/task.rs
rust/kernel/workqueue.rs
rust/macros/lib.rs