Skip to content

Commit 0eef6ec

Browse files
committed
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 <[email protected]> Acked-by: Konstantin Ryabitsev <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Miguel Ojeda <[email protected]>
1 parent 96fff2d commit 0eef6ec

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

Documentation/rust/general-information.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,17 @@ Rust kernel code is documented using ``rustdoc``, its built-in documentation
2222
generator.
2323

2424
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:
2726

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/
2936

3037
The docs can also be easily generated and read locally. This is quite fast
3138
(same order as compiling the code itself) and no special tools or environment

Documentation/rust/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ configurations.
3232
.. only:: not rustdoc and html
3333

3434
This documentation does not include rustdoc generated information.
35+
A pregenerated version is provided at:
36+
37+
https://rust.docs.kernel.org
3538

3639
.. toctree::
3740
:maxdepth: 1

0 commit comments

Comments
 (0)