Skip to content

Commit

Permalink
docs: rust: link to https://rust.docs.kernel.org
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ojeda committed Aug 25, 2024
1 parent 96fff2d commit 0eef6ec
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
13 changes: 10 additions & 3 deletions Documentation/rust/general-information.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,17 @@ Rust kernel code is documented using ``rustdoc``, its built-in documentation
generator.

The generated HTML docs include integrated search, linked items (e.g. types,
functions, constants), source code, etc. They may be read at (TODO: link when
in mainline and generated alongside the rest of the documentation):
functions, constants), source code, etc. They may be read at:

http://kernel.org/
https://rust.docs.kernel.org

For linux-next, please see:

https://rust.docs.kernel.org/next/

There are also tags for each main release, e.g.:

https://rust.docs.kernel.org/6.10/

The docs can also be easily generated and read locally. This is quite fast
(same order as compiling the code itself) and no special tools or environment
Expand Down
3 changes: 3 additions & 0 deletions Documentation/rust/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ configurations.
.. only:: not rustdoc and html

This documentation does not include rustdoc generated information.
A pregenerated version is provided at:

https://rust.docs.kernel.org

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit 0eef6ec

Please sign in to comment.