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: 48fadf44 ("docs: Move rustdoc output, cross-reference it") Link: https://lore.kernel.org/rust-for-linux/20231026154525.6d14b495@eugeo/ [2] 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>
Showing
- Documentation/rust/coding-guidelines.rst 13 additions, 0 deletionsDocumentation/rust/coding-guidelines.rst
- rust/Makefile 2 additions, 1 deletionrust/Makefile
- rust/kernel/error.rs 1 addition, 1 deletionrust/kernel/error.rs
- rust/kernel/ioctl.rs 1 addition, 1 deletionrust/kernel/ioctl.rs
- rust/kernel/kunit.rs 1 addition, 1 deletionrust/kernel/kunit.rs
- rust/kernel/print.rs 4 additions, 4 deletionsrust/kernel/print.rs
- rust/kernel/sync/condvar.rs 1 addition, 1 deletionrust/kernel/sync/condvar.rs
- rust/kernel/sync/lock/mutex.rs 1 addition, 1 deletionrust/kernel/sync/lock/mutex.rs
- rust/kernel/sync/lock/spinlock.rs 1 addition, 1 deletionrust/kernel/sync/lock/spinlock.rs
- rust/kernel/task.rs 1 addition, 1 deletionrust/kernel/task.rs
- rust/kernel/workqueue.rs 1 addition, 1 deletionrust/kernel/workqueue.rs
- rust/macros/lib.rs 1 addition, 1 deletionrust/macros/lib.rs
Please register or sign in to comment