cargo-doc(1)

描述

为本地包及其所有依赖项构建文档。输出结果会以 rustdoc 的常用格式放置在 target/doc 中。

选项

文档选项

--open: 构建文档后在浏览器中打开。这将使用你的默认浏览器，除非你在 BROWSER 环境变量中定义了另一个浏览器，或者使用 doc.browser 配置选项。
--no-deps: 不为依赖项构建文档。
--document-private-items: 在文档中包含非公共项。如果正在为二进制目标生成文档，则默认启用此选项。

包选择

默认情况下，如果没有提供包选择选项，则选择的包取决于选择的清单文件（如果未给出 --manifest-path，则基于当前工作目录）。如果清单是工作区的根，则会选择工作区的默认成员，否则只会选择清单定义的包。

工作区的默认成员可以使用根清单中的 workspace.default-members 键显式设置。如果未设置，则虚拟工作区将包含所有工作区成员（等效于传递 --workspace），而非虚拟工作区将仅包含根 crate 本身。

-p spec…
--package spec…: 仅为指定的包生成文档。有关 SPEC 格式，请参阅 cargo-pkgid(1)。此标志可以指定多次，并支持常见的 Unix glob 模式，如 *、? 和 []。但是，为了避免你的 shell 在 Cargo 处理之前意外地展开 glob 模式，你必须在每个模式周围使用单引号或双引号。
--workspace: 为工作区中的所有成员生成文档。
--all: --workspace 的已弃用别名。
--exclude SPEC…: 排除指定的包。必须与 --workspace 标志一起使用。此标志可以指定多次，并支持常见的 Unix glob 模式，如 *、? 和 []。但是，为了避免你的 shell 在 Cargo 处理之前意外地展开 glob 模式，你必须在每个模式周围使用单引号或双引号。

目标选择

如果没有给出目标选择选项，cargo doc 将为所选包的所有二进制和库目标生成文档。如果二进制文件的名称与 lib 目标相同，则会跳过该二进制文件。如果二进制文件缺少 required-features，则会跳过它们。

可以通过在清单设置中为目标设置 doc = false 来更改默认行为。使用目标选择选项将忽略 doc 标志，并且始终会为给定的目标生成文档。

--lib: 为包的库生成文档。
--bin name…: 为指定的二进制文件生成文档。此标志可以指定多次，并支持常见的 Unix glob 模式。
--bins: 为所有二进制目标生成文档。
--example name…: 为指定的示例生成文档。此标志可以指定多次，并支持常见的 Unix glob 模式。
--examples: 为所有示例目标生成文档。

功能选择

功能标志允许你控制启用哪些功能。如果没有给出功能选项，则会为每个选定的包激活 default 功能。

有关更多详细信息，请参阅功能文档。

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

编译选项

--target triple

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

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

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

-r

--release

使用 release 配置文件生成优化的工件文档。另请参阅 --profile 选项，以按名称选择特定配置文件。

--profile name

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

--timings=fmts

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

html（不稳定，需要 -Zunstable-options）：将人类可读的文件 cargo-timing.html 写入到 target/cargo-timings 目录，其中包含编译报告。如果你想查看较旧的运行，也可以在同一目录中写入带有时间戳的报告。HTML 输出仅适用于人类使用，不提供机器可读的时间数据。
json（不稳定，需要 -Zunstable-options）：发出有关计时信息的机器可读 JSON 信息。

输出选项

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

显示选项

-v

--verbose

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

-q

--quiet

不打印 cargo 日志消息。也可以使用 term.quiet 配置值指定。

--color when

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

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

也可以使用 term.color 配置值指定。

--message-format fmt

诊断消息的输出格式。可以指定多次，并且包含逗号分隔的值。有效值

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 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。

--lockfile-path 路径

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

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

常用选项

+工具链

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

--config 键=值 或路径

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

-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，而不是在第一个构建失败的 crate 上中止构建。

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