From 9a2a324da356b84b96dd90779c583e38fd546c5b Mon Sep 17 00:00:00 2001
From: lovely-shark <779931346@qq.com>
Date: Thu, 2 Jun 2022 11:47:33 +0800
Subject: [PATCH] docs(command): update cargo run description
---
src/commands/cargo-run.md | 104 +++++++++-----------------------------
1 file changed, 25 insertions(+), 79 deletions(-)
diff --git a/src/commands/cargo-run.md b/src/commands/cargo-run.md
index d54e559..f712aaf 100644
--- a/src/commands/cargo-run.md
+++ b/src/commands/cargo-run.md
@@ -1,56 +1,32 @@
-# cargo-run(1)
+## 名字
+cargo-run —— 运行当前包
-## NAME
+## 概要（synopsis）
-cargo-run - Run the current package
+`cargo run` [options] [`--` args]
-## SYNOPSIS
+### 描述
-`cargo run` [_options_] [`--` _args_]
+运行一个二进制或者本地包的实例
+所有在 两个横线（`--`） 后面的参数都会被传递给二进制程序来运行。如果你需要同时传递一些参数给 Cargo 和二进制程序，那么在 `--` 后面的将会给二进制，在`--`前面的将会给 Cargo。
-## DESCRIPTION
+## 选项
-Run a binary or example of the local package.
+### 包选择
-All the arguments following the two dashes (`--`) are passed to the binary to
-run. If you're passing arguments to both Cargo and the binary, the ones after
-`--` go to the binary, the ones before go to Cargo.
+默认情况下，选择的是当前工作目录中的包。`-p`标志可以用来选择在工作目录中的一个不同的包。
+`-p`spec
+`--package` spec
+运行包。SPEC 格式参考[cargo-pkgid(1)](https://rustwiki.org/zh-CN/cargo/commands/cargo-pkgid.html)。
-## OPTIONS
-
-### Package Selection
-
-By default, the package in the current working directory is selected. The `-p`
-flag can be used to choose a different package in a workspace.
-
-
-
--p spec--package spec- The package to run. See cargo-pkgid(1) for the SPEC
-format.
-
-
-
-
-
-### Target Selection
-
-When no target selection options are given, `cargo run` will run the binary
-target. If there are multiple binary targets, you must pass a target flag to
-choose one. Or, the `default-run` field may be specified in the `[package]`
-section of `Cargo.toml` to choose the name of the binary to run by default.
-
-
-
---bin name- Run the specified binary.
-
-
---example name- Run the specified example.
+### 目标选择
+当没有传目标选项，`cargo run`将会运行二进制目标。如果有多个二进制目标，你必须传递一个目标标志来选中他们中的一个。或者 在 `Cargo.toml`的`[package]` 中的`default-run`字段指定一个运行时候的默认二进制名。
+`--bin` name
+运行一个特定的二进制
+`--example` name
+运行特定的例子
@@ -67,18 +43,14 @@ section of `Cargo.toml` to choose the name of the binary to run by default.
传递以空格或者逗号分隔的列表，其中给出要启用的特性。工作区成员的特性可通过包名/特性名的语法启用。
此参数可多次给定，以分别启用给定的特性。
-
--all-features
为给定的包启用全部可用特性
-
--no-default-features
不启用给定包的default特性
-
-
### Compilation Options
@@ -91,27 +63,19 @@ section of `Cargo.toml` to choose the name of the binary to run by default.
注意，指定该标志参数会使Cargo产生的构建工件放在与平常不同的目录下。
详情参见build cache
-
-
-r--release- Run optimized artifacts with the
release profile.
See also the --profile option for choosing a specific profile by name.
-
-
--profile name- Run with the given profile.
See the the reference for more details on profiles.
-
-
--ignore-rust-version- Run the target even if the selected Rust compiler is older than the
required Rust version as configured in the project's
rust-version field.
-
-
### Output Options
@@ -122,7 +86,6 @@ required Rust version as configured in the project's rust-version f
build.target-dir config value指定。
默认情况下为根工作区中的target目录。
-
### Display Options
@@ -135,13 +98,11 @@ required Rust version as configured in the project's rust-version f
也可通过term.verbose指定。
config value.
-
-q
--quiet
不输出Cargo的日志信息。也可通过term.quiet指定。
config value.
-
--color when
控制输出内容的颜色。有效取值如下：
-
-
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times
and consists of comma-separated values. Valid values:
@@ -176,8 +135,6 @@ JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
coming from rustc are still emitted. Cannot be used with human or short.
-
-
### Manifest Options
@@ -187,8 +144,6 @@ coming from rustc are still emitted. Cannot be used with human or <
--manifest-path path
用于指定Cargo.toml文件的路径。默认情况下，Cargo会在当前目录或上级目录中寻找Cargo.toml文件。
-
-
--frozen
--locked
这两个选项用于保证Cargo.lock文件是最新的。如果该锁文件不存在，或者不是最新的，Cargo
@@ -196,7 +151,6 @@ coming from rustc are still emitted. Cannot be used with human or <
这些选项，可用于保证Cargo.lock文件是最新的(比如持续集成的构建过程)，
或用于避免联网。
-
--offline
禁止Cargo访问网络。如果不添加此选项，Cargo在需要访问网络但网络不可用的情况下，会报错
并停止工作。添加此选项后，Cargo会尽可能尝试不使用网络来工作。
@@ -205,8 +159,6 @@ Cargo只会使用本地已下载的crate，即便本地的索引副本中表明
所需依赖的方法，参见 cargo-fetch(1) 。
也可以通过 net.offline config value指定。
-
-
### Common Options
@@ -220,19 +172,15 @@ as +stable or +nightly).
See the rustup documentation
for more information about how toolchain overrides work.
-
-h
--help
Prints help information.
-
-Z flag
Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-
-
### Miscellaneous Options
@@ -241,29 +189,27 @@ for more information about how toolchain overrides work.
- 要并行运行的作业数量。也可通过
build.jobs config value指定。
默认为CPU数量。
-
## 环境
-关于Cargo所读取的环境变量，可参见[the reference](../reference/environment-variables.html)
-
+关于 Cargo 所读取的环境变量，可参见[the reference](../reference/environment-variables.html)
## 退出状态
-* `0`: Cargo命令执行成功
-* `101`: Cargo命令未能完成.
-
+- `0`: Cargo 命令执行成功
+- `101`: Cargo 命令未能完成.
## EXAMPLES
1. Build the local package and run its main target (assuming only one binary):
- cargo run
+ cargo run
2. Run an example with extra arguments:
- cargo run --example exname -- --exoption exarg1 exarg2
+ cargo run --example exname -- --exoption exarg1 exarg2
## SEE ALSO
+
[cargo(1)](cargo.html), [cargo-build(1)](cargo-build.html)