Documentation/rust/index.rst at master · tjh.dev/kernel

tjh.dev / kernel

Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

kernel os linux

kernel / Documentation / rust / index.rst

at master 42 lines 951 B view raw

 1.. SPDX-License-Identifier: GPL-2.0
 2
 3Rust
 4====
 5
 6Documentation related to Rust within the kernel. To start using Rust
 7in the kernel, please read the quick-start.rst guide.
 8
 9
10Code documentation
11------------------
12
13Given a kernel configuration, the kernel may generate Rust code documentation,
14i.e. HTML rendered by the ``rustdoc`` tool.
15
16.. only:: rustdoc and html
17
18	This kernel documentation was built with `Rust code documentation
19	<rustdoc/kernel/index.html>`_.
20
21.. only:: not rustdoc and html
22
23	This kernel documentation was not built with Rust code documentation.
24
25A pregenerated version is provided at:
26
27	https://rust.docs.kernel.org
28
29Please see the :ref:`Code documentation <rust_code_documentation>` section for
30more details.
31
32.. toctree::
33    :maxdepth: 1
34
35    quick-start
36    general-information
37    coding-guidelines
38    arch-support
39    testing
40
41You can also find learning materials for Rust in its section in
42:doc:`../process/kernel-docs`.