summaryrefslogtreecommitdiffstats
path: root/Documentation/rust/general-information.rst
diff options
context:
space:
mode:
authorMiguel Ojeda <ojeda@kernel.org>2024-08-18 16:12:00 +0200
committerMiguel Ojeda <ojeda@kernel.org>2024-08-25 18:37:40 +0200
commitb2bf463ed9a8131ad4e91a11af8c9a4ec84b876a (patch)
tree7afb992969179a321bd8d6100fe83bfec2e18383 /Documentation/rust/general-information.rst
parentdocs: rust: link to https://rust.docs.kernel.org (diff)
downloadlinux-b2bf463ed9a8131ad4e91a11af8c9a4ec84b876a.tar.xz
linux-b2bf463ed9a8131ad4e91a11af8c9a4ec84b876a.zip
docs: rust: improve main page introducing a "Code documentation" section
Clean the "Rust" main page by introducing a 'Code documentation" section to separate it from the rest of the text above. In addition, introduce the "Rust code documentation" term, which may be clearer than referring to a potentially unknown tool. Furthermore, for the HTML case, homogenize both `rustdoc` and non-`rustdoc` cases and use the term introduced above instead. Then, always generate the pregenerated version part, since now there is a section that is always generated and thus makes sense to do so. Finally, finish the new section with a link to more details about the Rust code documentation. The intention is that: - The non-HTML case mentions the code documentation too, making it more prominent for readers of non-HTML docs. - Both HTML cases read more naturally. - The pregenerated version is always mentioned, since it is likely useful for readers of non-HTML docs. Link: https://lore.kernel.org/r/20240818141200.386899-2-ojeda@kernel.org Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Diffstat (limited to 'Documentation/rust/general-information.rst')
-rw-r--r--Documentation/rust/general-information.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/rust/general-information.rst b/Documentation/rust/general-information.rst
index 2dec01888d53..2d76e09da121 100644
--- a/Documentation/rust/general-information.rst
+++ b/Documentation/rust/general-information.rst
@@ -15,6 +15,8 @@ but not `std <https://doc.rust-lang.org/std/>`_. Crates for use in the
kernel must opt into this behavior using the ``#![no_std]`` attribute.
+.. _rust_code_documentation:
+
Code documentation
------------------