xref: /openbmc/linux/Documentation/rust/index.rst (revision e2ad626f)
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.. only:: rustdoc and html
10
11	You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
12
13.. only:: not rustdoc and html
14
15	This documentation does not include rustdoc generated information.
16
17.. toctree::
18    :maxdepth: 1
19
20    quick-start
21    general-information
22    coding-guidelines
23    arch-support
24
25.. only::  subproject and html
26
27   Indices
28   =======
29
30   * :ref:`genindex`
31