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.

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

Improve doc for cargo install #6354

Merged
merged 1 commit into from
Nov 27, 2018
Merged

Improve doc for cargo install #6354

merged 1 commit into from
Nov 27, 2018

Conversation

collin5
Copy link
Contributor

@collin5 collin5 commented Nov 27, 2018

Fixes #4417

@dwijnand
Copy link
Member

There's some more info in cargo help install but I guess this wouldn't be terrible to add.

@bors: r+

@bors
Copy link
Contributor

bors commented Nov 27, 2018

📌 Commit b738f48 has been approved by dwijnand

@bors
Copy link
Contributor

bors commented Nov 27, 2018

⌛ Testing commit b738f48 with merge 0273e73...

bors added a commit that referenced this pull request Nov 27, 2018
Improve doc for `cargo install`

Fixes #4417
@bors
Copy link
Contributor

bors commented Nov 27, 2018

☀️ Test successful - status-appveyor, status-travis
Approved by: dwijnand
Pushing 0273e73 to master...

@bors bors merged commit b738f48 into rust-lang:master Nov 27, 2018
@lukaslueg
Copy link
Contributor

Not so fast!? Documenting by $HOME assumes that targeted environments actually have such a thing and that people are familiar with the concept. Maybe we could print the actual value as an extra line?

Binaries will be installed to C:\Users\foobar\....

@dwijnand
Copy link
Member

Is it not safe to assume that Windows developers are aware of what's meant by "$HOME" even if such a thing doesn't exist on their platform?

@collin5
Copy link
Contributor Author

collin5 commented Nov 28, 2018

Would it be ok to replace $HOME with the actual value? I guess this can be got by calling home on the Config object.

pub fn home(&self) -> &Filesystem {
cc @dwijnand @lukaslueg

@lukaslueg
Copy link
Contributor

One can use the code in install to figure out where cargo will install binaries.

AFAICS it's the result of resolve_root()/bin, which takes environment variables and custom config into account.

@collin5
Copy link
Contributor Author

collin5 commented Nov 28, 2018

Makes sense. Going to raise a follow-up PR for this. Thanks!

@dwijnand
Copy link
Member

I'm concerned that using the real home path might make that help line silly long (if HOME is a long path). But maybe I shouldn't be so concerned :)

@collin5
Copy link
Contributor Author

collin5 commented Nov 28, 2018

@dwijnand Should we truncate the path if it exceeds a certain length?

@collin5
Copy link
Contributor Author

collin5 commented Nov 28, 2018

Seems fine by me then. Thank you!

@collin5 collin5 deleted the b4417 branch November 28, 2018 17:11
bors added a commit to rust-lang/rust that referenced this pull request Dec 4, 2018
Update cargo, rls

26 commits in b3d0b2e545b61d4cd08096911724b7d49d213f73..5e85ba14aaa20f8133863373404cb0af69eeef2c
2018-11-15 19:13:04 +0000 to 2018-12-02 14:37:25 +0000
- ConflictStoreTrie: Faster filtered search (rust-lang/cargo#6366)
- Remove `cmake` as a requirement (rust-lang/cargo#6368)
- progress: display "Downloading 1 crate" instead of "Downloading 1 crates" (rust-lang/cargo#6369)
- Use expect over unwrap, for panic-in-panic aborts (rust-lang/cargo#6364)
- Switch to pretty_env_logger, under --features pretty-env-logger (rust-lang/cargo#6362)
- use allow-dirty option in `cargo package` to skip vcs checks (rust-lang/cargo#6280)
- remove clones made redundant by Intern PackageId (rust-lang/cargo#6352)
- docs: correct profile usage of `cargo test --release` (rust-lang/cargo#6345)
- Improve doc for `cargo install` (rust-lang/cargo#6354)
- Intern PackageId (rust-lang/cargo#6332)
- Clean only release artifacts if --release option is set (rust-lang/cargo#6349)
- remove clones made redundant by Intern SourceId (rust-lang/cargo#6347)
- Intern SourceId (rust-lang/cargo#6342)
- Tweak Layout to allow for non json file targets with internal "." (rust-lang/cargo#6255)
- Correct Target Directory command-line option (rust-lang/cargo#6343)
- Persistent data structures by im-rs (rust-lang/cargo#6336)
- Move command prelude into main library (rust-lang/cargo#6335)
- Distinguish custom build invocations (rust-lang/cargo#6331)
- Allow crate_type=bin examples to run (rust-lang/cargo#6330)
- Make verify-project honour unstable features (rust-lang/cargo#6326)
- Make autodiscovery disable inferred targets (rust-lang/cargo#6329)
- Add `c` alias for `check` (rust-lang/cargo#6218)
- Allow user aliases to override built-in aliases (rust-lang/cargo#6259)
- Fix renaming directory project using build scripts with cross-compiling. (rust-lang/cargo#6328)
- Fix add_plugin_deps-related tests. (rust-lang/cargo#6327)
- Add a glossary. (rust-lang/cargo#6321)
@ehuss ehuss added this to the 1.32.0 milestone Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cargo install help text is not very helpful
5 participants