Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: clarify --path is the installation source not destination #13205

Merged
merged 3 commits into from
Dec 26, 2023
Merged

fix: clarify --path is the installation source not destination #13205

merged 3 commits into from
Dec 26, 2023

Conversation

weihanglo
Copy link
Member

What does this PR try to resolve?

There is a misunderstanding of “default location” mentioned in cargo install --help.
I don't think one-line explanation helps much there, So remove that imprecise description.

This PR also add more "from" for places mentioning installation sources.

How should we test and review this PR?

Read the new help text.

Additional information

Fixes #13200

@rustbot
Copy link
Collaborator

rustbot commented Dec 25, 2023

r? @ehuss

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added A-cli Area: Command-line interface, option parsing, etc. A-cli-help Area: built-in command-line help A-documenting-cargo-itself Area: Cargo's documentation Command-install S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 25, 2023
@weihanglo weihanglo mentioned this pull request Dec 25, 2023
Closed
Rustin170506
Rustin170506 approved these changes Dec 26, 2023
View reviewed changes
Copy link
Member

@Rustin170506 Rustin170506 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks! 👍

src/bin/cargo/cli.rs Outdated Show resolved Hide resolved
epage
epage approved these changes Dec 26, 2023
View reviewed changes
Copy link
Contributor

@epage epage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to r= once you take care of hi-rustin's comment

@weihanglo
Copy link
Member Author

Thank you all :)

@bors r=hi-rustin

@bors
Copy link
Contributor

bors commented Dec 26, 2023

📌 Commit eb8870f has been approved by hi-rustin

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 26, 2023
@bors
Copy link
Contributor

bors commented Dec 26, 2023

⌛ Testing commit eb8870f with merge 308ceee...

@bors
Copy link
Contributor

bors commented Dec 26, 2023

☀️ Test successful - checks-actions
Approved by: hi-rustin
Pushing 308ceee to master...

@bors bors merged commit 308ceee into rust-lang:master Dec 26, 2023
20 checks passed
@weihanglo weihanglo deleted the install branch December 26, 2023 17:06
@weihanglo weihanglo mentioned this pull request Dec 27, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 27, 2023
@bors
Auto merge of rust-lang#119334 - weihanglo:update-cargo, r=weihanglo
0961661 
Update cargo

7 commits in 363a2d11320faf531f6aacd1ea067c6bc08343b9..ac6bbb33293d8d424c17ecdb42af3aac25fb7295
2023-12-22 03:12:42 +0000 to 2023-12-26 23:22:08 +0000
- docs: fix link to nightly doc of cargo-util-schemas (rust-lang/cargo#13209)
- doc: improve word usage (rust-lang/cargo#13206)
- fix: clarify `--path` is the installation source not destination (rust-lang/cargo#13205)
- refactor: give some better examples for package ID spec (rust-lang/cargo#13202)
- chore: fix a typo (rust-lang/cargo#13201)
- Extend the build directive syntax with `cargo::` (rust-lang/cargo#12201)
- Rework `--check-cfg` generation comment (rust-lang/cargo#13195)

r? ghost
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 27, 2023
@bors
Auto merge of rust-lang#119334 - weihanglo:update-cargo, r=weihanglo
625c2c4 
Update cargo

7 commits in 363a2d11320faf531f6aacd1ea067c6bc08343b9..ac6bbb33293d8d424c17ecdb42af3aac25fb7295
2023-12-22 03:12:42 +0000 to 2023-12-26 23:22:08 +0000
- docs: fix link to nightly doc of cargo-util-schemas (rust-lang/cargo#13209)
- doc: improve word usage (rust-lang/cargo#13206)
- fix: clarify `--path` is the installation source not destination (rust-lang/cargo#13205)
- refactor: give some better examples for package ID spec (rust-lang/cargo#13202)
- chore: fix a typo (rust-lang/cargo#13201)
- Extend the build directive syntax with `cargo::` (rust-lang/cargo#12201)
- Rework `--check-cfg` generation comment (rust-lang/cargo#13195)

r? ghost
@rustbot rustbot added this to the 1.77.0 milestone Dec 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Rustin170506 Rustin170506 Rustin170506 approved these changes

@epage epage epage approved these changes

Assignees

@ehuss ehuss

Labels
A-cli Area: Command-line interface, option parsing, etc. A-cli-help Area: built-in command-line help A-documenting-cargo-itself Area: Cargo's documentation Command-install S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.77.0
Development

Successfully merging this pull request may close these issues.

Cargo install documentation should no longer mention default location
6 participants
@weihanglo @rustbot @bors @epage @Rustin170506 @ehuss