1.. SPDX-License-Identifier: GPL-2.0 2.. include:: ../disclaimer-zh_CN.rst 3 4:Original: Documentation/rust/general-information.rst 5 6:翻译: 7 8 司延腾 Yanteng Si <siyanteng@loongson.cn> 9 10 11基本信息 12======== 13 14本文档包含了在内核中使用Rust支持时需要了解的有用信息。 15 16 17代码文档 18-------- 19 20Rust内核代码使用其内置的文档生成器 ``rustdoc`` 进行记录。 21 22生成的HTML文档包括集成搜索、链接项（如类型、函数、常量）、源代码等。它们可以在以下地址阅读 23（TODO：当在主线中时链接，与其他文档一起生成）： 24 25 http://kernel.org/ 26 27这些文档也可以很容易地在本地生成和阅读。这相当快（与编译代码本身的顺序相同），而且不需要特 28殊的工具或环境。这有一个额外的好处，那就是它们将根据所使用的特定内核配置进行定制。要生成它 29们，请使用 ``rustdoc`` 目标，并使用编译时使用的相同调用，例如:: 30 31 make LLVM=1 rustdoc 32 33要在你的网络浏览器中本地阅读该文档，请运行如:: 34 35 xdg-open Documentation/output/rust/rustdoc/kernel/index.html 36 37要了解如何编写文档，请看 coding-guidelines.rst 。 38 39 40额外的lints 41----------- 42 43虽然 ``rustc`` 是一个非常有用的编译器，但一些额外的lints和分析可以通过 ``clippy`` 44（一个Rust linter）来实现。要启用它，请将CLIPPY=1传递到用于编译的同一调用中，例如:: 45 46 make LLVM=1 CLIPPY=1 47 48请注意，Clippy可能会改变代码生成，因此在构建产品内核时不应该启用它。 49 50抽象和绑定 51---------- 52 53抽象是用Rust代码包装来自C端的内核功能。 54 55为了使用来自C端的函数和类型，需要创建绑定。绑定是Rust对那些来自C端的函数和类型的声明。 56 57例如，人们可以在Rust中写一个 ``Mutex`` 抽象，它从C端包装一个 ``Mutex结构体`` ，并 58通过绑定调用其函数。 59 60抽象并不能用于所有的内核内部API和概念，但随着时间的推移，我们打算扩大覆盖范围。“Leaf” 61模块（例如，驱动程序）不应该直接使用C语言的绑定。相反，子系统应该根据需要提供尽可能安 62全的抽象。 63 64 65有条件的编译 66------------ 67 68Rust代码可以访问基于内核配置的条件性编译: 69 70.. code-block:: rust 71 72 #[cfg(CONFIG_X)] // Enabled (`y` or `m`) 73 #[cfg(CONFIG_X="y")] // Enabled as a built-in (`y`) 74 #[cfg(CONFIG_X="m")] // Enabled as a module (`m`) 75 #[cfg(not(CONFIG_X))] // Disabled 76