| 1 | |
| 2 |
|
| 3 | Rust
|
| 4 | ====
|
| 5 |
|
| 6 | Documentation related to Rust within the kernel. To start using Rust
|
| 7 | in the kernel, please read the quick-start.rst guide.
|
| 8 |
|
| 9 |
|
| 10 | Code documentation
|
| 11 | ------------------
|
| 12 |
|
| 13 | Given a kernel configuration, the kernel may generate Rust code documentation,
|
| 14 | i.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 |
|
| 25 | A pregenerated version is provided at:
|
| 26 |
|
| 27 | https://rust.docs.kernel.org
|
| 28 |
|
| 29 | Please see the :ref:`Code documentation <rust_code_documentation>` section for
|
| 30 | more details.
|
| 31 |
|
| 32 | .. toctree::
|
| 33 | :maxdepth: 1
|
| 34 |
|
| 35 | quick-start
|
| 36 | general-information
|
| 37 | coding-guidelines
|
| 38 | arch-support
|
| 39 | testing
|
| 40 |
|
| 41 | You can also find learning materials for Rust in its section in
|
| 42 | :doc:`../process/kernel-docs`.
|