50 lines
1.2 KiB
ReStructuredText
50 lines
1.2 KiB
ReStructuredText
|
.. 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.
|
||
|
|
|
||
|
|
|
||
|
|
The Rust experiment
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
The Rust support was merged in v6.1 into mainline in order to help in
|
||
|
|
determining whether Rust as a language was suitable for the kernel, i.e. worth
|
||
|
|
the tradeoffs.
|
||
|
|
|
||
|
|
Currently, the Rust support is primarily intended for kernel developers and
|
||
|
|
maintainers interested in the Rust support, so that they can start working on
|
||
|
|
abstractions and drivers, as well as helping the development of infrastructure
|
||
|
|
and tools.
|
||
|
|
|
||
|
|
If you are an end user, please note that there are currently no in-tree
|
||
|
|
drivers/modules suitable or intended for production use, and that the Rust
|
||
|
|
support is still in development/experimental, especially for certain kernel
|
||
|
|
configurations.
|
||
|
|
|
||
|
|
|
||
|
|
.. only:: rustdoc and html
|
||
|
|
|
||
|
|
You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
|
||
|
|
|
||
|
|
.. only:: not rustdoc and html
|
||
|
|
|
||
|
|
This documentation does not include rustdoc generated information.
|
||
|
|
|
||
|
|
.. toctree::
|
||
|
|
:maxdepth: 1
|
||
|
|
|
||
|
|
quick-start
|
||
|
|
general-information
|
||
|
|
coding-guidelines
|
||
|
|
arch-support
|
||
|
|
|
||
|
|
.. only:: subproject and html
|
||
|
|
|
||
|
|
Indices
|
||
|
|
=======
|
||
|
|
|
||
|
|
* :ref:`genindex`
|