Miguel Ojeda bc2e7d5c29 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: 48fadf4400 ("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>		2023-12-21 20:54:17 +01:00
..
arch-support.rst	rust: sort uml documentation arch support table	2023-04-06 23:11:04 +02:00
coding-guidelines.rst	rust: support srctree-relative links	2023-12-21 20:54:17 +01:00
general-information.rst	docs: rust: update Rust docs output path	2023-10-19 16:39:03 +02:00
index.rst	docs: rust: add "The Rust experiment" section	2023-10-25 03:14:00 +02:00
quick-start.rst	docs: rust: clarify what 'rustup override' does	2023-08-21 00:36:41 +02:00