Skip to content

Commit

Permalink
Auto merge of #11351 - hi-rustin:rustin-patch-alias-docs, r=weihanglo
Browse files Browse the repository at this point in the history
Add `rm` alias to configuration docs

### What does this PR try to resolve?

close #11348

Add `rm` alias to configuration docs.

r? `@weihanglo`
  • Loading branch information
bors committed Nov 8, 2022
2 parents 3115dd6 + 381f9c8 commit 5ccea51
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/doc/src/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ precedence rules as other options specified directly with `--config`.
### Config-relative paths

Paths in config files may be absolute, relative, or a bare name without any path separators.
Paths for executables without a path separator will use the `PATH` environment variable to search for the executable.
Paths for executables without a path separator will use the `PATH` environment variable to search for the executable.
Paths for non-executables will be relative to where the config value is defined.

In particular, rules are:
Expand All @@ -258,7 +258,7 @@ In particular, rules are:
>
> To avoid unexpected results, the rule of thumb is putting your extra config files
> at the same level of discovered `.cargo/config.toml` in your porject.
> For instance, given a project `/my/project`,
> For instance, given a project `/my/project`,
> it is recommended to put config files under `/my/project/.cargo`
> or a new directory at the same level, such as `/my/project/.config`.
Expand Down Expand Up @@ -348,6 +348,7 @@ c = "check"
d = "doc"
t = "test"
r = "run"
rm = "remove"
```

Aliases are not allowed to redefine existing built-in commands.
Expand Down

0 comments on commit 5ccea51

Please sign in to comment.