Documentation/rust/index.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   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 The Rust experiment
  11 -------------------
  12
  13 The Rust support was merged in v6.1 into mainline in order to help in
  14 determining whether Rust as a language was suitable for the kernel, i.e. worth
  15 the tradeoffs.
  16
  17 Currently, the Rust support is primarily intended for kernel developers and
  18 maintainers interested in the Rust support, so that they can start working on
  19 abstractions and drivers, as well as helping the development of infrastructure
  20 and tools.
  21
  22 If you are an end user, please note that there are currently no in-tree
  23 drivers/modules suitable or intended for production use, and that the Rust
  24 support is still in development/experimental, especially for certain kernel
  25 configurations.
  26
  27
  28 .. only:: rustdoc and html
  29
  30         You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
  31
  32 .. only:: not rustdoc and html
  33
  34         This documentation does not include rustdoc generated information.
  35
  36 .. toctree::
  37     :maxdepth: 1
  38
  39     quick-start
  40     general-information
  41     coding-guidelines
  42     arch-support
  43
  44 .. only::  subproject and html
  45
  46    Indices
  47    =======
  48
  49    * :ref:`genindex`