cargo-rustdoc(1)

名称

cargo-rustdoc — 使用指定的自定义标志构建包文档

概要

cargo rustdoc [选项] [-- 参数]

描述

将使用指定的 *参数* 记录当前包（如果提供 -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 规范
--package 规范
要记录的包。有关规范格式，请参阅 cargo-pkgid(1)。

目标选择

当未给出目标选择选项时，cargo rustdoc 将记录所选包的所有二进制和库目标。如果二进制文件的名称与 lib 目标相同，则将跳过该二进制文件。如果二进制文件具有缺少的 required-features，则将跳过它们。

传递目标选择标志将仅记录指定的 target。

请注意，--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 名称
使用给定的配置文件记录。有关配置文件的更多详细信息，请参阅参考。
--timings=fmts
输出信息，说明每次编译所需的时间，并跟踪一段时间内的并发信息。接受可选的逗号分隔的输出格式列表；不带参数的 --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 消息输出到标准输出。有关更多详细信息，请参阅参考。与 human 和 short 冲突。
  • json-diagnostic-short：确保 JSON 消息的 rendered 字段包含来自 rustc 的“简短”渲染。不能与 human 或 short 一起使用。
  • json-diagnostic-rendered-ansi：确保 JSON 消息的 rendered 字段包含嵌入式 ANSI 颜色代码，以遵循 rustc 的默认配色方案。不能与 human 或 short 一起使用。
  • json-render-diagnostics：指示 Cargo 不要在打印的 JSON 消息中包含 rustc 诊断信息，而是 Cargo 本身应该渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息和其他来自 rustc 的诊断信息仍然会被输出。不能与 human 或 short 一起使用。

清单选项

--manifest-path 路径
Cargo.toml 文件的路径。默认情况下，Cargo 会在当前目录或任何父目录中搜索 Cargo.toml 文件。
--ignore-rust-version
忽略软件包中的 rust-version 规范。
--locked
断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时完全相同。在出现以下任一情况时，Cargo 将退出并报错

  • 缺少锁文件。
  • 由于依赖项解析不同，Cargo 尝试更改锁文件。

它可以在需要确定性构建的环境中使用，例如在 CI 管道中。

--offline
阻止 Cargo 出于任何原因访问网络。如果没有此标志，Cargo 在需要访问网络而网络不可用时将停止并报错。使用此标志，Cargo 将尝试在可能的情况下在没有网络的情况下继续进行。

请注意，这可能会导致与在线模式不同的依赖项解析。Cargo 将限制自己使用本地下载的 crate，即使本地索引副本中指示可能有更新的版本。请参阅 cargo-fetch(1) 命令以下载依赖项，然后再脱机。

也可以使用 net.offline 配置值 指定。

--frozen
等效于同时指定 --locked 和 --offline。

通用选项

+工具链
如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。
--config 键=值 或 路径
覆盖 Cargo 配置值。参数应采用 键=值 的 TOML 语法，或作为额外配置文件的路径提供。此标志可以指定多次。有关更多信息，请参阅 命令行覆盖部分。
-C 路径
在执行任何指定的操作之前更改当前工作目录。例如，这会影响 Cargo 默认情况下在何处查找项目清单 (Cargo.toml)，以及搜索 .cargo/config.toml 的目录。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 夜间版通道 上可用，并且需要 -Z unstable-options 标志才能启用（请参阅 #10098）。

-h
--help
打印帮助信息。
-Z 标志
Cargo 的不稳定（仅限夜间版）标志。运行 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
输出文档的类型。有效值

此选项仅在 夜间版通道 上可用，并且需要 -Z unstable-options 标志才能启用。

环境

有关 Cargo 读取的环境变量的详细信息，请参阅参考。

退出状态

  • 0：Cargo 成功。
  • 101：Cargo 未能完成。

示例

  1. 使用从给定文件包含的自定义 CSS 构建文档

    cargo rustdoc --lib -- --extend-css extra.css

另请参阅

cargo(1)、cargo-doc(1)、rustdoc(1)