diff options
Diffstat (limited to 'Documentation/rust/index.rst')
| -rw-r--r-- | Documentation/rust/index.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/Documentation/rust/index.rst b/Documentation/rust/index.rst new file mode 100644 index 000000000..b78ed0efa --- /dev/null +++ b/Documentation/rust/index.rst @@ -0,0 +1,42 @@ +.. SPDX-License-Identifier: GPL-2.0 + +Rust +==== + +Documentation related to Rust within the kernel. To start using Rust +in the kernel, please read the quick-start.rst guide. + + +Code documentation +------------------ + +Given a kernel configuration, the kernel may generate Rust code documentation, +i.e. HTML rendered by the ``rustdoc`` tool. + +.. only:: rustdoc and html + + This kernel documentation was built with `Rust code documentation + <rustdoc/kernel/index.html>`_. + +.. only:: not rustdoc and html + + This kernel documentation was not built with Rust code documentation. + +A pregenerated version is provided at: + + https://rust.docs.kernel.org + +Please see the :ref:`Code documentation <rust_code_documentation>` section for +more details. + +.. toctree:: + :maxdepth: 1 + + quick-start + general-information + coding-guidelines + arch-support + testing + +You can also find learning materials for Rust in its section in +:doc:`../process/kernel-docs`. |