Skip to content

Commit

Permalink
docs(cargo-install): clarify default location is about "sources"
Browse files Browse the repository at this point in the history
  • Loading branch information
weihanglo committed Dec 26, 2023
1 parent 48cffc6 commit eb8870f
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions src/doc/man/cargo-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ installed, and all executables are installed into the installation root's
{{> description-install-root }}

There are multiple sources from which a crate can be installed. The default
location is crates.io but the `--git`, `--path`, and `--registry` flags can
change this source. If the source contains more than one package (such as
source location is crates.io but the `--git`, `--path`, and `--registry` flags
can change this source. If the source contains more than one package (such as
crates.io or a git repository with multiple crates) the _crate_ argument is
required to indicate which crate should be installed.

Expand Down
9 changes: 5 additions & 4 deletions src/doc/man/generated_txt/cargo-install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@ DESCRIPTION
o $HOME/.cargo

There are multiple sources from which a crate can be installed. The
default location is crates.io but the --git, --path, and --registry
flags can change this source. If the source contains more than one
package (such as crates.io or a git repository with multiple crates) the
crate argument is required to indicate which crate should be installed.
default source location is crates.io but the --git, --path, and
--registry flags can change this source. If the source contains more
than one package (such as crates.io or a git repository with multiple
crates) the crate argument is required to indicate which crate should be
installed.

Crates from crates.io can optionally specify the version they wish to
install via the --version flags, and similarly packages from git
Expand Down
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ The installation root is determined, in order of precedence:
- `$HOME/.cargo`

There are multiple sources from which a crate can be installed. The default
location is crates.io but the `--git`, `--path`, and `--registry` flags can
change this source. If the source contains more than one package (such as
source location is crates.io but the `--git`, `--path`, and `--registry` flags
can change this source. If the source contains more than one package (such as
crates.io or a git repository with multiple crates) the _crate_ argument is
required to indicate which crate should be installed.

Expand Down
4 changes: 2 additions & 2 deletions src/etc/man/cargo-install.1
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ The installation root is determined, in order of precedence:
.RE
.sp
There are multiple sources from which a crate can be installed. The default
location is crates.io but the \fB\-\-git\fR, \fB\-\-path\fR, and \fB\-\-registry\fR flags can
change this source. If the source contains more than one package (such as
source location is crates.io but the \fB\-\-git\fR, \fB\-\-path\fR, and \fB\-\-registry\fR flags
can change this source. If the source contains more than one package (such as
crates.io or a git repository with multiple crates) the \fIcrate\fR argument is
required to indicate which crate should be installed.
.sp
Expand Down

0 comments on commit eb8870f

Please sign in to comment.