Warning

此文件的目的是为让中文读者更容易阅读和理解，而不是作为一个分支。 因此， 如果您对此文件有任何意见或更新，请先尝试更新原始英文文件。

Note

如果您发现本文档与原始文件有任何不同或者有翻译问题，请联系该文件的译者， 或者请求时奎亮的帮助：<alexs@kernel.org>。

Original:

General Information

翻译:

司延腾 Yanteng Si <siyanteng@loongson.cn>

基本信息

本文档包含了在内核中使用Rust支持时需要了解的有用信息。

代码文档

Rust内核代码使用其内置的文档生成器 rustdoc 进行记录。

生成的HTML文档包括集成搜索、链接项（如类型、函数、常量）、源代码等。它们可以在以下地址阅读 （TODO：当在主线中时链接，与其他文档一起生成）：

这些文档也可以很容易地在本地生成和阅读。这相当快（与编译代码本身的顺序相同），而且不需要特 殊的工具或环境。这有一个额外的好处，那就是它们将根据所使用的特定内核配置进行定制。要生成它 们，请使用 rustdoc 目标，并使用编译时使用的相同调用，例如:

make LLVM=1 rustdoc

要在你的网络浏览器中本地阅读该文档，请运行如:

xdg-open rust/doc/kernel/index.html

要了解如何编写文档，请看 编码指南 。

额外的lints

虽然 rustc 是一个非常有用的编译器，但一些额外的lints和分析可以通过 clippy （一个Rust linter）来实现。要启用它，请将CLIPPY=1传递到用于编译的同一调用中，例如:

make LLVM=1 CLIPPY=1

请注意，Clippy可能会改变代码生成，因此在构建产品内核时不应该启用它。

抽象和绑定

抽象是用Rust代码包装来自C端的内核功能。

为了使用来自C端的函数和类型，需要创建绑定。绑定是Rust对那些来自C端的函数和类型的声明。

例如，人们可以在Rust中写一个 Mutex 抽象，它从C端包装一个 Mutex结构体 ，并 通过绑定调用其函数。

抽象并不能用于所有的内核内部API和概念，但随着时间的推移，我们打算扩大覆盖范围。“Leaf” 模块（例如，驱动程序）不应该直接使用C语言的绑定。相反，子系统应该根据需要提供尽可能安 全的抽象。

有条件的编译

Rust代码可以访问基于内核配置的条件性编译:

#[cfg(CONFIG_X)]       // Enabled               (`y` or `m`)
#[cfg(CONFIG_X="y")]   // Enabled as a built-in (`y`)
#[cfg(CONFIG_X="m")]   // Enabled as a module   (`m`)
#[cfg(not(CONFIG_X))]  // Disabled