65 lines · plain
1.. SPDX-License-Identifier: GPL-2.02 3Rust4====5 6Documentation related to Rust within the kernel. To start using Rust7in the kernel, please read the quick-start.rst guide.8 9 10The Rust experiment11-------------------12 13The Rust support was merged in v6.1 into mainline in order to help in14determining whether Rust as a language was suitable for the kernel, i.e. worth15the tradeoffs.16 17Currently, the Rust support is primarily intended for kernel developers and18maintainers interested in the Rust support, so that they can start working on19abstractions and drivers, as well as helping the development of infrastructure20and tools.21 22If you are an end user, please note that there are currently no in-tree23drivers/modules suitable or intended for production use, and that the Rust24support is still in development/experimental, especially for certain kernel25configurations.26 27 28Code documentation29------------------30 31Given a kernel configuration, the kernel may generate Rust code documentation,32i.e. HTML rendered by the ``rustdoc`` tool.33 34.. only:: rustdoc and html35 36 This kernel documentation was built with `Rust code documentation37 <rustdoc/kernel/index.html>`_.38 39.. only:: not rustdoc and html40 41 This kernel documentation was not built with Rust code documentation.42 43A pregenerated version is provided at:44 45 https://rust.docs.kernel.org46 47Please see the :ref:`Code documentation <rust_code_documentation>` section for48more details.49 50.. toctree::51 :maxdepth: 152 53 quick-start54 general-information55 coding-guidelines56 arch-support57 testing58 59.. only:: subproject and html60 61 Indices62 =======63 64 * :ref:`genindex`65