xref: /linux/Documentation/translations/zh_CN/rust/index.rst (revision f96163865a1346b199cc38e827269296f0f24ab0)
1.. SPDX-License-Identifier: GPL-2.0
2.. include:: ../disclaimer-zh_CN.rst
3
4:Original: Documentation/rust/index.rst
5
6:翻译:
7
8 司延腾 Yanteng Si <siyanteng@loongson.cn>
9
10Rust
11====
12
13与内核中的Rust有关的文档。若要开始在内核中使用Rust,请阅读 quick-start.rst 指南。
14
15Rust 实验
16---------
17Rust 支持在 v6.1 版本中合并到主线,以帮助确定 Rust 作为一种语言是否适合内核,
18即是否值得进行权衡。
19
20目前,Rust 支持主要面向对 Rust 支持感兴趣的内核开发人员和维护者,
21以便他们可以开始处理抽象和驱动程序,并帮助开发基础设施和工具。
22
23如果您是终端用户,请注意,目前没有适合或旨在生产使用的内置驱动程序或模块,
24并且 Rust 支持仍处于开发/实验阶段,尤其是对于特定内核配置。
25
26代码文档
27--------
28
29给定一个内核配置,内核可能会生成 Rust 代码文档,即由 ``rustdoc`` 工具呈现的 HTML。
30
31.. only:: rustdoc and html
32
33   该内核文档使用 `Rust 代码文档 <rustdoc/kernel/index.html>`_ 构建。
34
35.. only:: not rustdoc and html
36
37   该内核文档不使用 Rust 代码文档构建。
38
39预生成版本提供在:https://rust.docs.kernel.org40
41请参阅 :ref:`代码文档 <rust_code_documentation_zh_cn>` 部分以获取更多详细信息。
42
43.. toctree::
44    :maxdepth: 1
45
46    quick-start
47    general-information
48    coding-guidelines
49    arch-support
50    testing
51
52你还可以在 :doc:`../../../process/kernel-docs` 中找到 Rust 的学习材料。
53
54.. only::  subproject and html
55
56   Indices
57   =======
58
59   * :ref:`genindex`
60