From 555eefbc817633c3c17aa8579bb07baf022571f6 Mon Sep 17 00:00:00 2001 From: Yuki Okushi Date: Mon, 21 Jun 2021 21:46:43 +0900 Subject: [PATCH] Restore `rustdoc` section with the correct instruction Signed-off-by: Yuki Okushi --- Documentation/rust/quick-start.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst index d028f912235ef4..4a99317ecf3510 100644 --- a/Documentation/rust/quick-start.rst +++ b/Documentation/rust/quick-start.rst @@ -125,6 +125,18 @@ the component manually:: The standalone installers also come with ``clippy``. +rustdoc +******* + +If you install the ``rustdoc`` tool, then you will be able to generate pretty +HTML documentation for Rust code, including for the libraries (crates) inside +``rust/`` that are used by the rest of the kernel (for details, please see +:ref:`Documentation/rust/docs.rst `). + +If you are using ``rustup``, all the profiles already install the tool, +so you should be good to go. The standalone installers also come with ``rustdoc``. + + rust-analyzer *************