tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: rust: link to https://rust.docs.kernel.org

The Rust code documentation (i.e. `rustdoc`-generated docs) is now
available at:

https://rust.docs.kernel.org

Thus document it and remove the `TODO` line.

The generation uses a particular kernel configuration, based on x86_64,
which may get tweaked over time. Older tags, and how they are generated,
may also change in the future. We may consider freezing them at some
point, but for the moment, the content should not be considered immutable.

Thanks Konstantin for the support setting it up!

Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Acked-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Link: https://lore.kernel.org/r/20240818141200.386899-1-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Miguel Ojeda 0eef6ec5 96fff2dc

+13 -3
+10 -3
Documentation/rust/general-information.rst
··· 22 22 generator. 23 23 24 24 The generated HTML docs include integrated search, linked items (e.g. types, 25 - functions, constants), source code, etc. They may be read at (TODO: link when 26 - in mainline and generated alongside the rest of the documentation): 25 + functions, constants), source code, etc. They may be read at: 27 26 28 - http://kernel.org/ 27 + https://rust.docs.kernel.org 28 + 29 + For linux-next, please see: 30 + 31 + https://rust.docs.kernel.org/next/ 32 + 33 + There are also tags for each main release, e.g.: 34 + 35 + https://rust.docs.kernel.org/6.10/ 29 36 30 37 The docs can also be easily generated and read locally. This is quite fast 31 38 (same order as compiling the code itself) and no special tools or environment
+3
Documentation/rust/index.rst
··· 32 32 .. only:: not rustdoc and html 33 33 34 34 This documentation does not include rustdoc generated information. 35 + A pregenerated version is provided at: 36 + 37 + https://rust.docs.kernel.org 35 38 36 39 .. toctree:: 37 40 :maxdepth: 1