cargo-doc(1)

名称

cargo-doc — 构建包的文档

概要

cargo doc [选项]

描述

构建本地包及其所有依赖项的文档。输出将放置在 target/doc 中，采用 rustdoc 的标准格式。

选项

文档选项

--open

在构建文档后，在浏览器中打开它们。这将使用您的默认浏览器，除非您在 BROWSER 环境变量中定义了另一个浏览器，或者使用 doc.browser 配置选项。

--no-deps

不要构建依赖项的文档。

--document-private-items

在文档中包含非公开项目。如果记录二进制目标，则默认情况下将启用此选项。

包选择

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

工作区的默认成员可以通过根清单中的 workspace.default-members 键明确设置。如果未设置，虚拟工作区将包含所有工作区成员（等同于传递 --workspace），非虚拟工作区将只包含根箱体本身。

-p spec…

--package spec…

只记录指定的包。有关 SPEC 格式，请参阅 cargo-pkgid(1)。此标志可以多次指定，并支持常见的 Unix 通配符模式，如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理它们之前意外地扩展通配符模式，您必须在每个模式周围使用单引号或双引号。

--workspace

记录工作区中的所有成员。

--all

--workspace 的已弃用别名。

--exclude SPEC…

排除指定的包。必须与 --workspace 标志一起使用。此标志可以多次指定，并支持常见的 Unix 通配符模式，如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理它们之前意外地扩展通配符模式，您必须在每个模式周围使用单引号或双引号。

目标选择

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

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

--lib

记录包的库。

--bin name…

记录指定的二进制文件。此标志可以多次指定，并支持常见的 Unix 通配符模式。

--bins

记录所有二进制目标。

--example name…

记录指定的示例。此标志可以多次指定，并支持常见的 Unix 通配符模式。

--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）：在 target/cargo-timings 目录中写入一个名为 cargo-timing.html 的人类可读文件，其中包含编译报告。如果您想查看旧的运行，也会将报告写入同一个目录，文件名中包含时间戳。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 将限制自己使用本地下载的板条箱，即使本地索引副本中可能存在更新的版本。请参阅 cargo-fetch(1) 命令以在脱机之前下载依赖项。

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

--frozen

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

常用选项

+toolchain

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

--config KEY=VALUE 或 PATH

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

-C PATH

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

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

-h

--help

打印帮助信息。

-Z flag

Cargo 的不稳定（仅限 nightly）标志。运行 cargo -Z help 以获取详细信息。

其他选项

-j N

--jobs N

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

--keep-going

尽可能构建依赖关系图中的所有板条箱，而不是在第一个构建失败时中止构建。

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

环境

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

退出状态

• 0: Cargo 成功。
• 101: Cargo 无法完成。

示例

1. 构建本地包文档及其依赖项，并将输出到 target/doc。

   cargo doc
   

另请参阅

cargo(1)，cargo-rustdoc(1)，rustdoc(1)