xref: /openbmc/linux/Documentation/rust/index.rst (revision 48fadf44)
1d07479b2SMiguel Ojeda.. SPDX-License-Identifier: GPL-2.0
2d07479b2SMiguel Ojeda
3d07479b2SMiguel OjedaRust
4d07479b2SMiguel Ojeda====
5d07479b2SMiguel Ojeda
6d07479b2SMiguel OjedaDocumentation related to Rust within the kernel. To start using Rust
7d07479b2SMiguel Ojedain the kernel, please read the quick-start.rst guide.
8d07479b2SMiguel Ojeda
9*48fadf44SCarlos Bilbao.. only:: rustdoc and html
10*48fadf44SCarlos Bilbao
11*48fadf44SCarlos Bilbao	You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
12*48fadf44SCarlos Bilbao
13*48fadf44SCarlos Bilbao.. only:: not rustdoc and html
14*48fadf44SCarlos Bilbao
15*48fadf44SCarlos Bilbao	This documentation does not include rustdoc generated information.
16*48fadf44SCarlos Bilbao
17d07479b2SMiguel Ojeda.. toctree::
18d07479b2SMiguel Ojeda    :maxdepth: 1
19d07479b2SMiguel Ojeda
20d07479b2SMiguel Ojeda    quick-start
21d07479b2SMiguel Ojeda    general-information
22d07479b2SMiguel Ojeda    coding-guidelines
23d07479b2SMiguel Ojeda    arch-support
24d07479b2SMiguel Ojeda
25d07479b2SMiguel Ojeda.. only::  subproject and html
26d07479b2SMiguel Ojeda
27d07479b2SMiguel Ojeda   Indices
28d07479b2SMiguel Ojeda   =======
29d07479b2SMiguel Ojeda
30d07479b2SMiguel Ojeda   * :ref:`genindex`
31