1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-29 23:24:55 +02:00

cargo*: add Chinese translation (#12312)

* cargo-*: add Chinese translation

---------

Co-authored-by: Jack Lin <blueskyson1401@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
This commit is contained in:
Beriholic 2024-03-14 12:55:45 +08:00 committed by GitHub
parent 4efc84b7f1
commit 33770df77d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
38 changed files with 772 additions and 0 deletions

View file

@ -0,0 +1,32 @@
# cargo add
> 向 Rust 项目的 `Cargo.toml` 文件添加依赖项。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-add.html>.
- 将最新版本的依赖项添加到当前项目:
`cargo add {{依赖项}}`
- 添加特定版本的依赖项:
`cargo add {{依赖项}}@{{版本号}}`
- 添加依赖项并启动一个或多个特定功能:
`cargo add {{依赖项}} --features {{功能1}},{{功能2}}`
- 添加一个可选的依赖项,然后将其作为包(crate)的一个功能暴露出来:
`cargo add {{依赖项}} --optional`
- 将本地包(crate)添加为依赖项:
`cargo add --path {{path/to/directory}}`
- 添加一个开发或构建依赖项:
`cargo add {{依赖项}} --{{dev|build}}`
- 添加一个禁用所有默认功能的依赖项:
`cargo add {{依赖项}} --no-default-features`

View file

@ -0,0 +1,36 @@
# cargo bench
> 编译并执行基准测试。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-bench.html>.
- 执行包的所有基准测试:
`cargo bench`
- 在基准测试失败时不停止:
`cargo bench --no-fail-fast`
- 编译,但不运行基准测试:
`cargo bench --no-run`
- 对指定的基准进行基准测试:
`cargo bench --bench {{基准测试名称}}`
- 使用给定的配置文件进行基准测试 (默认为 `bench`):
`cargo bench --profile {{配置文件}}`
- 对所有示例目标进行基准测试:
`cargo bench --examples`
- 对所有二进制目标进行基准测试:
`cargo bench --bins`
- 对包的库(lib)进行基准测试:
`cargo bench --lib`

View file

@ -0,0 +1,32 @@
# cargo build
> 编译本地包及其所有依赖项。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-build.html>.
- 在本地路径中构建由 `Cargo.toml` 清单文件定义的一个或多个包:
`cargo build`
- 以 release 模式构建,并进行优化:
`cargo build --release`
- 要求 `Cargo.lock` 文件为最新版本:
`cargo build --locked`
- 构建工作区中的所有包:
`cargo build --workspace`
- 构建特定的包:
`cargo build --package {{包名}}`
- 仅构建指定的二进制文件:
`cargo build --bin {{名称}}`
- 仅构建指定的测试目标:
`cargo build --test {{测试名称}}`

View file

@ -0,0 +1,24 @@
# cargo check
> 检查本地软件包及其所有依赖包是否有错误。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-check.html>.
- 检查当前包:
`cargo check`
- 检查所有测试:
`cargo check --tests`
- 检查 `tests/integration_test1.rs` 中的集成测试:
`cargo check --test {{integration_test1}}`
- 使用 `feature1``feature2` 功能检查当前包:
`cargo check --features {{feature1,feature2}}`
- 禁用默认功能后检测当前包:
`cargo check --no-default-features`

View file

@ -0,0 +1,20 @@
# cargo clean
> 删除 `target` 目录中生成的构建产物。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-clean.html>.
- 删除整个 `target` 目录:
`cargo clean`
- 删除文档构建产物 (`target/doc` 目录):
`cargo clean --doc`
- 删除 release 模式的构建产物 (`target/release` 目录):
`cargo clean --release`
- 删除给定配置文件的目录中的构建产物(在本例中为 `target/debug`):
`cargo clean --profile {{dev}}`

View file

@ -0,0 +1,32 @@
# cargo clippy
> 一系列 lint 工具,用于捕获常见错误并改进 Rust 代码。
> 更多信息:<https://github.com/rust-lang/rust-clippy>.
- 对当前目录中的代码运行检查:
`cargo clippy`
- 要求 `Cargo.lock` 文件是最新的:
`cargo clippy --locked`
- 对工作区中的所有包进行检查:
`cargo clippy --workspace`
- 对某个包进行检查:
`cargo clippy --package {{包名}}`
- 将警告视为错误:
`cargo clippy -- --deny warnings`
- 运行检查并忽略警告:
`cargo clippy -- --allow warnings`
- 自动应用 Clippy 的建议:
`cargo clippy --fix`

View file

@ -0,0 +1,20 @@
# cargo doc
> 构建 Rust 包的文档。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-doc.html>.
- 为当前项目及所有依赖项构建文档:
`cargo doc`
- 不为依赖项构建文档:
`cargo doc --no-deps`
- 构建并在浏览器中打开文档:
`cargo doc --open`
- 构建并查看特定包的文档:
`cargo doc --open --package {{包名}}`

View file

@ -0,0 +1,12 @@
# cargo fetch
> 从网络获取包的依赖项。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-fetch.html>.
- 获取 `Cargo.lock` 中指定的依赖项 (对所有目标):
`cargo fetch`
- 为指定目标获取依赖项:
`cargo fetch --target {{目标三元组}}`

View file

@ -0,0 +1,28 @@
# cargo fix
> 自动修复 `rustc` 报告的 lint 警告。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-fix.html>.
- 即使已经有编译器错误,也要修复代码:
`cargo fix --broken-code`
- 即使工作目录有更改,也要修复代码:
`cargo fix --allow-dirty`
- 将一个包迁移到下一个 Rust 版本:
`cargo fix --edition`
- 修复包的库:
`cargo fix --lib`
- 修复指定的集成测试:
`cargo fix --test {{名称}}`
- 修复工作区中的所有成员:
`cargo fix --workspace`

View file

@ -0,0 +1,16 @@
# cargo fmt
> 在 Rust 项目中对所有源文件运行 `rustfmt`
> 更多信息:<https://github.com/rust-lang/rustfmt>.
- 格式化所有源文件:
`cargo fmt`
- 检查格式错误,不对文件进行写入操作:
`cargo fmt --check`
- 将参数传递给每个 rustfmt 调用:
`cargo fmt -- {{rustfmt参数}}`

View file

@ -0,0 +1,9 @@
# cargo generate-lockfile
> 为当前包生成 Cargo.lock 文件。类似于 cargo update,但选项更少。
> 如果锁定文件已经存在,它将使用每个包的最新版本重新构建。
> 更多信息:<https://doc.rust-lang.org/stable/cargo/commands/cargo-generate-lockfile.html>.
- 使用每个包的最新版本生成Cargo.lock文件:
`cargo generate-lockfile`

View file

@ -0,0 +1,12 @@
# cargo help
> 显示有关 cargo 及其子命令的帮助信息。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-help.html>.
- 显示一般帮助:
`cargo help`
- 显示子命令的帮助信息:
`cargo help {{子命令}}`

View file

@ -0,0 +1,25 @@
# cargo init
> 创建一个新的 Cargo 包。
> 相当于 `cargo new`,但是指定目录是可选的。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-init.html>.
- 在当前目录中初始化一个带有二进制目标的 Rust 项目:
`cargo init`
- 在指定目录中初始化一个带有二进制目标的 Rust 项目:
`cargo init {{path/to/directory}}`
- 在当前目录中初始化一个带有库目标的 Rust 项目:
`cargo init --lib`
- 在项目目录中初始化版本控制系统仓库 (默认为git):
`cargo init --vcs {{git|hg|pijul|fossil|none}}`
- 设置包名称 (默认为目录名称):
`cargo init --name {{name}}`

View file

@ -0,0 +1,20 @@
# cargo install
> 构建并安装一个 Rust 二进制文件。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-install.html>.
- 从 <https://crates.io> 安装一个包 (版本是可选的,默认为最新版本):
`cargo install {{包名}}@{{版本号}}`
- 从指定的 Git 仓库安装一个包:
`cargo install --git {{仓库URL}}`
- 从 Git 仓库安装时,根据指定的 branch/tag/commit 构建:
`cargo install --git {{仓库URL}} --{{branch|tag|rev}} {{branch_name|tag|commit_hash}}`
- 列出所有已安装的包及其版本:
`cargo install --list`

View file

@ -0,0 +1,21 @@
# cargo locate-project
> 打印项目的 `Cargo.toml` 清单文件的完整路径。
> 如果项目是工作区的一部分,则显示项目的清单文件,而不是工作区的清单文件。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-locate-project.html>.
- 显示包含完整路径到 `Cargo.toml` 清单文件的 JSON 对象:
`cargo locate-project`
- 以指定格式显示项目路径:
`cargo locate-project --message-format {{plain|json}}`
- 显示位于工作区根目录而不是当前工作区成员的 `Cargo.toml` 清单文件:
`cargo locate-project --workspace`
- 显示特定目录中的 `Cargo.toml` 清单文件:
`cargo locate-project --manifest-path {{path/to/Cargo.toml}}`

View file

@ -0,0 +1,13 @@
# cargo login
> 将 API 令牌保存到本地的凭据存储中。
> 该令牌用于对包注册表进行身份验证。您可以使用 `cargo logout` 来删除它。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-login.html>.
- 将 API 令牌添加到本地凭据存储中 (位于 `$CARGO_HOME/credentials.toml`):
`cargo login`
- 使用指定的注册表 (注册表名称可以在配置中定义,默认为 <https://crates.io>):
`cargo login --registry {{名称}}`

View file

@ -0,0 +1,13 @@
# cargo logout
> 从本地注册表中删除 API 令牌。
> 该令牌用于对包注册表进行身份验证。您可以使用 `cargo login` 将其添加回来。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-logout.html>.
- 从本地凭据存储中 (位于 `$CARGO_HOME/credentials.toml`) 移除 API 令牌:
`cargo logout`
- 使用指定的注册表 (注册表名称可以在配置中定义,默认为 <https://crates.io>):
`cargo logout --registry {{名称}}`

View file

@ -0,0 +1,21 @@
# cargo metadata
> 以 JSON 格式输出当前包的工作空间成员和已解析的依赖关系。
> 注意:输出格式可能在未来的 Cargo 版本中发生变化。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-metadata.html>.
- 打印当前包的工作空间成员和已解析的依赖关系:
`cargo metadata`
- 仅打印工作空间成员,不获取依赖项:
`cargo metadata --no-deps`
- 根据指定版本打印特定格式的元数据:
`cargo metadata --format-version {{版本号}}`
- 打印带有 `resolve` 字段的元数据,仅包括给定目标三元组的依赖关系 (注意:`packages` 数组仍将包括所有目标的依赖关系):
`cargo metadata --filter-platform {{目标三元组}}`

View file

@ -0,0 +1,9 @@
# cargo new
> 创建一个新的 Cargo 包。
> 相当于 `cargo init`,但是需要指定一个目录。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-new.html>.
- 使用二进制目标创建一个新的 Rust 项目:
`cargo new {{path/to/directory}}`

View file

@ -0,0 +1,20 @@
# cargo owner
> 管理包在注册表上的所有者。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-owner.html>.
- 邀请指定的用户或团队作为所有者:
`cargo owner --add {{用户名|github:机构名称:团队名称}} {{包名}}`
- 将指定的用户或团队从所有者中删除:
`cargo owner --remove {{用户名|github:机构名称:团队名称}} {{包名}}`
- 列出一个包的所有者:
`cargo owner --list {{包名}}`
- 使用指定的注册表 (注册表名称可以在配置中定义,默认为 <https://crates.io>):
`cargo owner --registry {{名称}}`

View file

@ -0,0 +1,13 @@
# cargo package
> 将本地包装成一个可分发的 tarball 文件(`.crate` 文件)。
> 类似于 `cargo publish --dry-run`,但具有更多选项。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-package.html>.
- 执行检查并创建一个 `.crate` 文件 (相当于 `cargo publish --dry-run`):
`cargo package`
- 显示将包含在tarball中的文件,而不实际创建它:
`cargo package --list`

View file

@ -0,0 +1,12 @@
# cargo pkgid
> 打印当前工作空间中包或依赖项的完全限定包 ID 指定符。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-pkgid.html>.
- 打印当前项目的完全限定包规范:
`cargo pkgid`
- 打印指定包的完全限定包规范:
`cargo pkgid {{部分包规范}}`

View file

@ -0,0 +1,17 @@
# cargo publish
> 将包上传到注册表。
> 注意:在发布包之前,您必须使用 `cargo login` 添加身份验证令牌。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-publish.html>.
- 执行检查,创建一个 `.crate` 文件并将其上传到注册表:
`cargo publish`
- 执行检查,创建一个 `.crate` 文件,但不上传它 (相当于 `cargo package`):
`cargo publish --dry-run`
- 使用指定的注册表 (注册表名称可以在配置中定义,默认为 <https://crates.io>):
`cargo publish --registry {{名称}}`

View file

@ -0,0 +1,16 @@
# cargo remove
> 从 Rust 项目的 `Cargo.toml` 清单中移除依赖关系。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-remove.html>.
- 从当前项目中移除一个依赖项:
`cargo remove {{依赖项}}`
- 移除开发或构建依赖项:
`cargo remove --{{dev|build}} {{依赖项}}`
- 移除给定目标平台的依赖项:
`cargo remove --target {{目标平台}} {{依赖项}}`

View file

@ -0,0 +1,16 @@
# cargo report
> 显示各种类型的报告。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-report.html>.
- 显示一个报告:
`cargo report {{future-incompatibilities|...}}`
- 显示具有指定由 Cargo 生成的 id 的报告:
`cargo report {{future-incompatibilities|...}} --id {{id}}`
- 为指定的包显示报告:
`cargo report {{future-incompatibilities|...}} --package {{package}}`

View file

@ -0,0 +1,33 @@
# cargo run
> 运行当前的 Cargo 包。
> 注意: 执行的二进制文件的工作目录将设置为当前工作目录。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-run.html>.
- 运行默认的二进制目标:
`cargo run`
- 运行指定的二进制文件:
`cargo run --bin {{名称}}`
- 运行指定的示例:
`cargo run --example {{示例名}}`
- 激活一系列以空格或逗号分隔的功能:
`cargo run --features {{功能1 功能2 ...}}`
- 禁用默认功能:
`cargo run --no-default-features`
- 激活所有可用的功能:
`cargo run --all-features`
- 使用指定的配置文件运行:
`cargo run --profile {{配置文件名称}}`

View file

@ -0,0 +1,37 @@
# cargo rustc
> 编译一个 Rust 包。类似于 `cargo build`,但您可以向编译器传递额外的选项。
> 查看 `rustc --help` 获取所有可用选项。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-rustc.html>.
- 构建包并向 `rustc` 传递选项:
`cargo rustc -- {{rustc_options}}`
- 在 release 模式下构建构建,启用优化:
`cargo rustc --release`
- 使用针对当前 CPU 的特定架构优化编译:
`cargo rustc --release -- -C target-cpu=native`
- 使用速度优化编译:
`cargo rustc -- -C opt-level {{1|2|3}}`
- 使用 [s]ize 优化编译(`z` 也会关闭循环向量化):
`cargo rustc -- -C opt-level {{s|z}}`
- 检查您的包是否使用了不安全的代码:
`cargo rustc --lib -- -D unsafe-code`
- 构建特定的包:
`cargo rustc --package {{package}}`
- 仅构建指定的二进制文件:
`cargo --bin {{名称}}`

View file

@ -0,0 +1,33 @@
# cargo rustdoc
> 构建 Rust 包的文档。
> 类似于 `cargo doc`,但您可以向 `rustdoc` 传递选项。查看 `rustdoc --help` 获取所有可用选项。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-rustdoc.html>.
- 向 `rustdoc` 传递选项:
`cargo rustdoc -- {{rustdoc_options}}`
- 关于文档 lint 发出警告:
`cargo rustdoc -- --warn rustdoc::{{lint_name}}`
- 忽略文档 lint:
`cargo rustdoc -- --allow rustdoc::{{lint_name}}`
- 为包的库生成文档:
`cargo rustdoc --lib`
- 为指定的二进制文件生成文档:
`cargo rustdoc --bin {{名称}}`
- 为指定的示例生成文档:
`cargo rustdoc --example {{名称}}`
- 为指定的集成测试生成文档:
`cargo rustdoc --test {{名称}}`

View file

@ -0,0 +1,13 @@
# cargo search
> 在 https://crates.io 上搜索包。
> 显示包及其描述,以 TOML 格式显示,可复制到 `Cargo.toml` 中。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-search.html>.
- 搜索包:
`cargo search {{查询词}}`
- 显示 n 个结果 (默认为 10,最多为 100):
`cargo search --limit {{n}} {{查询词}}`

View file

@ -0,0 +1,28 @@
# cargo test
> 执行 Rust 包的单元测试和集成测试。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-test.html>.
- 仅运行包含特定字符串在其名称中的测试:
`cargo test {{测试名称}}`
- 设置并行运行测试用例的数量:
`cargo test -- --test-threads {{数量}}`
- 在 release 模式下测试构建,启用优化:
`cargo test --release`
- 测试工作区中的所有包:
`cargo test --workspace`
- 为特定包运行测试:
`cargo test --package {{包名}}`
- 运行测试时不隐藏测试执行的输出:
`cargo test -- --nocapture`

View file

@ -0,0 +1,25 @@
# cargo tree
> 显示依赖图的树形可视化。
> 注意:在树中,标有 `(*)` 的包的依赖已在图的其他位置显示过,因此不会重复显示。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-tree.html>.
- 显示当前项目的依赖树:
`cargo tree`
- 仅显示到指定深度的依赖 (例如,当 `n` 为 1 时,仅显示直接依赖):
`cargo tree --depth {{n}}`
- 在树中不显示给定的包(及其依赖):
`cargo tree --prune {{package_spec}}`
- 显示重复依赖的所有出现:
`cargo tree --no-dedupe`
- 仅显示 normal/build/dev 依赖:
`cargo tree --edges {{normal|build|dev}}`

View file

@ -0,0 +1,8 @@
# cargo uninstall
> 移除使用 `cargo install` 安装的 Rust 二进制文件。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-uninstall.html>.
- 移除一个已安装的二进制文件:
`cargo remove {{package_spec}}`

View file

@ -0,0 +1,20 @@
# cargo update
> 更新记录在 `Cargo.lock` 中的依赖关系。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-update.html>.
- 将 `Cargo.lock` 中的依赖项更新为可能的最新版本:
`cargo update`
- 显示将会更新的内容,但实际上不写入锁定文件:
`cargo update --dry-run`
- 仅更新指定的依赖项:
`cargo update --package {{依赖项1}} --package {{依赖项2}} --package {{依赖项3}}`
- 将特定依赖项设置为特定版本:
`cargo update --package {{依赖项}} --precise {{1.2.3}}`

View file

@ -0,0 +1,8 @@
# cargo vendor
> 将项目的所有依赖项存储到指定目录中(默认为 `vendor`)。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-vendor.html>.
- 将依赖项存储到指定目录,并配置在当前项目中使用这些存储的源代码:
`cargo vendor {{path/to/directory}} > .cargo/config.toml`

View file

@ -0,0 +1,12 @@
# cargo verify-project
> 检查 `Cargo.toml` 文件清单的正确性,并将结果以 JSON 对象的形式打印出来。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-verify-project.html>.
- 检查当前项目清单的正确性:
`cargo verify-project`
- 检查指定清单文件的正确性:
`cargo verify-project --manifest-path {{path/to/Cargo.toml}}`

View file

@ -0,0 +1,12 @@
# cargo version
> 显示 `cargo` 版本信息。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-version.html>.
- 显示版本:
`cargo version`
- 显示额外的构建信息:
`cargo version --verbose`

View file

@ -0,0 +1,17 @@
# cargo yank
> 从索引中移除发布的包。应该只在意外发布了一个严重错误的包时使用。
> 注意:这不会删除任何数据。包在被撤回后仍然存在,只是阻止新项目使用它。
> 更多信息:<https://doc.rust-lang.org/cargo/commands/cargo-yank.html>.
- 撤回指定版本的包:
`cargo yank {{包名}}@{{版本号}}`
- 撤销撤回 (即允许再次下载):
`cargo yank --undo {{包名}}@{{版本号}}`
- 使用指定的注册表 (注册表名称可以在配置中定义 - 默认为 <https//crates.io>):
`cargo yank --registry {{名称}} {{包名}}@{{版本号}}`

37
pages.zh/common/cargo.md Normal file
View file

@ -0,0 +1,37 @@
# cargo
> 管理 Rust 项目及其模块依赖项(crates)。
> 一些子命令,如 `build`,具有自己的用法文档。
> 更多信息:<https://doc.rust-lang.org/cargo>.
- 搜索包:
`cargo search {{搜索关键词}}`
- 下载二进制包(crate):
`cargo install {{包名}}`
- 列出已安装的二进制包(crate):
`cargo install --list`
- 在指定目录 (或默认情况下在当前工作目录) 中创建一个新的二进制或库 Rust项目:
`cargo init --{{bin|lib}} {{path/to/directory}}`
- 向当前目录的 `Cargo.toml` 添加一个依赖:
`cargo add {{依赖项目}}`
- 使用 release 模式在当前目录中构建 Rust 项目:
`cargo build --release`
- 使用最新的编译器在当前目录中构建 Rust 项目 (需要 `rustup`):
`cargo +nightly build`
- 使用特定数量的线程构建 (默认为逻辑 CPU 的数量):
`cargo build --jobs {{线程数}}`