cargo-rustdoc(1)

描述

当前包（如果提供了 -p，则为指定包）的指定目标将使用传递给最终 rustdoc 调用的指定参数进行文档生成。依赖项不会作为此命令的一部分生成文档。请注意，rustdoc 仍将无条件接收诸如 -L、--extern 和 --crate-type 之类的参数，而指定的参数将简单地添加到 rustdoc 调用中。

有关 rustdoc 标志的文档，请参阅 https://doc.rust-lang.net.cn/rustdoc/index.html。

当提供额外参数时，此命令要求只编译一个目标。如果当前包有多个目标可用，则必须使用 --lib、--bin 等过滤选项来选择要编译哪个目标。

要将标志传递给 Cargo 生成的所有 rustdoc 进程，请使用 RUSTDOCFLAGS 环境变量或 build.rustdocflags 配置值。

选项

文档选项

--open: 构建文档后在浏览器中打开。除非您在 BROWSER 环境变量中定义了其他浏览器或使用 doc.browser 配置选项，否则将使用您的默认浏览器。

包选择

默认情况下，选择当前工作目录中的包。可以使用 -p 标志在工作区中选择不同的包。

-p spec
--package spec: 要生成文档的包。有关 SPEC 格式，请参阅 cargo-pkgid(1)。

目标选择

如果未给出目标选择选项，则 cargo rustdoc 将生成所选包的所有二进制和库目标的文档。如果二进制文件的名称与 lib 目标的名称相同，则将跳过该二进制文件。如果二进制文件具有缺失的 required-features，则跳过该二进制文件。

传递目标选择标志将仅生成指定目标的文档。

请注意，--bin、--example、--test 和 --bench 标志也支持常见的 Unix glob 模式，如 *、? 和 []。但是，为了避免 shell 在 Cargo 处理之前意外扩展 glob 模式，您必须在每个 glob 模式周围使用单引号或双引号。

--lib: 生成包的库文档。
--bin 名称…: 生成指定二进制文件的文档。此标志可以多次指定，并支持常见的 Unix glob 模式。
--bins: 生成所有二进制目标的文档。
--example 名称…: 生成指定示例的文档。此标志可以多次指定，并支持常见的 Unix glob 模式。
--examples: 生成所有示例目标的文档。
--test 名称…: 生成指定集成测试的文档。此标志可以多次指定，并支持常见的 Unix glob 模式。
--tests: 生成所有清单中设置了 test = true 标志的目标的文档。默认情况下，这包括构建为单元测试的库和二进制文件以及集成测试。请注意，这也会构建任何必需的依赖项，因此 lib 目标可能会构建两次（一次作为单元测试，一次作为二进制文件、集成测试等的依赖项）。可以通过在目标的清单设置中设置 test 标志来启用或禁用目标。
--bench 名称…: 生成指定基准测试的文档。此标志可以多次指定，并支持常见的 Unix glob 模式。
--benches: 生成所有清单中设置了 bench = true 标志的目标的文档。默认情况下，这包括构建为基准测试的库和二进制文件以及基准测试目标。请注意，这也会构建任何必需的依赖项，因此 lib 目标可能会构建两次（一次作为基准测试，一次作为二进制文件、基准测试等的依赖项）。可以通过在目标的清单设置中设置 bench 标志来启用或禁用目标。
--all-targets: 生成所有目标的文档。这等同于指定 --lib --bins --tests --benches --examples。

特性选择

特性标志允许您控制启用哪些特性。如果未给出任何特性选项，则会为每个选定的包激活 default 特性。

有关更多详细信息，请参阅特性文档。

-F 特性
--features 特性: 要激活的以空格或逗号分隔的特性列表。可以使用 package-name/feature-name 语法启用工作区成员的特性。此标志可以多次指定，这将启用所有指定的特性。
--all-features: 激活所有选定包的所有可用特性。
--no-default-features: 不激活选定包的 default 特性。

编译选项

--target 三元组

为给定的架构生成文档。默认值为宿主架构。三元组的通用格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 以获取支持的目标列表。此标志可以多次指定。

也可以使用 build.target 配置值进行指定。

请注意，指定此标志会使 Cargo 在另一种模式下运行，其中目标构建产物放置在单独的目录中。有关更多详细信息，请参阅构建缓存文档。

-r

--release

使用 release profile 生成优化构建产物的文档。另请参阅 --profile 选项，按名称选择特定的 profile。

--profile 名称

使用给定的 profile 生成文档。有关 profile 的更多详细信息，请参阅参考。

--timings=格式

输出每个编译花费的时间信息，并跟踪随时间的并发信息。接受可选的逗号分隔的输出格式列表；不带参数的 --timings 将默认为 --timings=html。指定输出格式（而非默认格式）是不稳定的，需要 -Zunstable-options。有效输出格式

html (不稳定，需要 -Zunstable-options)：将人类可读的文件 cargo-timing.html 写入 target/cargo-timings 目录，其中包含编译报告。如果您想查看旧的运行结果，还会在同一目录中写入一个文件名带有时间戳的报告。HTML 输出仅适合人类阅读，不提供机器可读的计时数据。
json (不稳定，需要 -Zunstable-options)：输出关于计时信息的机器可读 JSON 数据。

输出选项

--target-dir 目录: 所有生成的构建产物和中间文件的目录。也可以通过 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值指定。默认为工作区根目录下的 target。

显示选项

-v

--verbose

使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括依赖项警告和构建脚本输出等额外信息。也可以通过 term.verbose 配置值指定。

-q

--quiet

不打印 Cargo 日志消息。也可以通过 term.quiet 配置值指定。

--color 何时

控制何时使用彩色输出。有效值

auto (默认)：自动检测终端是否支持颜色。
always：始终显示颜色。
never：从不显示颜色。

也可以通过 term.color 配置值指定。

--message-format 格式

诊断消息的输出格式。可以多次指定，由逗号分隔的值组成。有效值

human (默认)：以人类可读的文本格式显示。与 short 和 json 冲突。
short：输出更短、人类可读的文本消息。与 human 和 json 冲突。
json：将 JSON 消息输出到 stdout。有关更多详细信息，请参阅参考。与 human 和 short 冲突。
json-diagnostic-short：确保 JSON 消息的 rendered 字段包含 rustc 的“短”渲染结果。不能与 human 或 short 一起使用。
json-diagnostic-rendered-ansi：确保 JSON 消息的 rendered 字段包含嵌入的 ANSI 颜色代码，以遵循 rustc 的默认颜色方案。不能与 human 或 short 一起使用。
json-render-diagnostics：指示 Cargo 不要将 rustc 诊断信息包含在打印的 JSON 消息中，而是由 Cargo 本身渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息以及来自 rustc 的其他信息仍会输出。不能与 human 或 short 一起使用。

清单选项

--manifest-path 路径

Cargo.toml 文件的路径。默认情况下，Cargo 在当前目录或任何父目录中搜索 Cargo.toml 文件。

--ignore-rust-version

忽略包中的 rust-version 规范。

--locked

断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时完全相同。在以下任一情况下，Cargo 将报错退出：

lock 文件缺失。
Cargo 尝试更改 lock 文件，因为依赖项解析不同。

可以在需要确定性构建的环境中使用此选项，例如在 CI 流水线中。

--offline

阻止 Cargo 访问网络。如果不使用此标志，如果 Cargo 需要访问网络但网络不可用，则会报错停止。使用此标志，如果可能，Cargo 将尝试在没有网络的情况下继续执行。

请注意，这可能导致与在线模式不同的依赖项解析。Cargo 将仅限于本地下载的 crate，即使本地索引副本中可能指示有更新的版本。请参阅 cargo-fetch(1) 命令，以便在离线前下载依赖项。

也可以通过 net.offline 配置值指定。

--frozen

相当于同时指定 --locked 和 --offline。

--lockfile-path 路径

将 lock 文件的路径从默认值（<workspace_root>/Cargo.lock）更改为路径。路径必须以 Cargo.lock 结尾（例如 --lockfile-path /tmp/temporary-lockfile/Cargo.lock）。请注意，提供 --lockfile-path 将忽略默认路径下现有的 lock 文件，转而使用路径中的 lock 文件，如果该路径不存在 lock 文件，则写入新的 lock 文件到提供的路径中。此标志可用于在只读目录中运行大多数命令，并将 lock 文件写入提供的路径。

此选项仅在 nightly channel 上可用，并且需要 -Z unstable-options 标志才能启用（参见 #14421）。

通用选项

+工具链

如果 Cargo 是使用 rustup 安装的，并且 cargo 命令的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。

--config 键=值 或路径

覆盖 Cargo 配置值。参数应为 TOML 语法 KEY=VALUE，或作为额外配置文件的路径提供。此标志可以多次指定。有关更多信息，请参阅命令行覆盖部分。

-C 路径

在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单 (Cargo.toml) 的位置，以及搜索 .cargo/config.toml 等文件的目录。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 nightly channel 上可用，并且需要 -Z unstable-options 标志才能启用（参见 #10098）。

-h

--help

打印帮助信息。

-Z 标志

Cargo 的不稳定（仅 nightly）标志。运行 cargo -Z help 查看详情。

杂项选项

-j N

--jobs N

并行运行的作业数。也可以通过 build.jobs 配置值指定。默认为逻辑 CPU 数。如果为负值，则将最大并行作业数设置为逻辑 CPU 数加上提供的值。如果提供字符串 default，则将其值重置为默认值。不应为 0。

--keep-going

尽可能多地构建依赖关系图中的 crate，而不是在第一个构建失败时中止构建。

例如，如果当前包依赖于依赖项 fails 和 works，其中一个构建失败，则 cargo rustdoc -j1 可能构建也可能不构建成功的那个（取决于 Cargo 首先选择运行哪一个），而 cargo rustdoc -j1 --keep-going 肯定会运行两个构建，即使先运行的那个失败。

--output-format