Mention that aliases are recursive #10935
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ehuss (or someone else) soon. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
epage
reviewed
Aug 3, 2022
Instead of duplicating portions of commands that are used identically across many aliases, the user can instead reuse any previously defined aliases.
|
@epage I changed the example a bit: [alias]
rr = "run --release"
recursive_example = "rr --example recursions"And modified the rr = "run --release"
space_example = ["run", "--release", "--", "\"command list\""]to that: rr = "run --release"
recursive_example = "rr --example recursions"
space_example = ["run", "--release", "--", "\"command list\""]I preferred adding it as new example so we don't lose the one with the array notation. I also decided not to do the recursion in the array example so people don't get confused when skimming it. Is that alright? |
|
@bors r+ |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Aug 10, 2022
Update cargo 7 commits in 4fd148c47e733770c537efac5220744945d572ef..ce40690a5e4e315d3dab0aae1eae69d0252c52ac 2022-08-03 15:03:52 +0000 to 2022-08-09 22:32:17 +0000 - Make the `rust-version` error recommend `cargo update --precise -p crate@ver` (rust-lang/cargo#10891) - resolver docs: link to version requirements syntax full explanation (rust-lang/cargo#10946) - Bump os_info to 3.5.0 (rust-lang/cargo#10943) - Mark --timings=html unstable in the document (rust-lang/cargo#10941) - Mention that aliases are recursive (rust-lang/cargo#10935) - Test if reserved filenames are allowed in Windows (rust-lang/cargo#10322) - improve error message for `no such subcommand` (rust-lang/cargo#10924)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of duplicating portions of commands that are used identically across many aliases, the user can instead reuse any previously defined aliases.
What does this PR try to resolve?
Today I started working with
xtask, which is a build system based on a simple cargo alias:Since the word "xtask" is rather difficult to type in my opinion (at least my left hand struggles quite a bit) I wanted to add another alias,
xas a shorthand (similar to whatbuild,run, etc. have by default). Thereby I discovered that I needn't replicate the whole alias, because aliases are recursive. I consulted the docs and couldn't find a mention of this, hence I'm adding it as part of this PR so other users can discover it.How should we test and review this PR?
I don't think this requires a separate test, it's a minor change to the documentation only.
Additional information