-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Conversation
There's some more info in @bors: r+ |
📌 Commit b738f48 has been approved by |
Improve doc for `cargo install` Fixes #4417
☀️ Test successful - status-appveyor, status-travis |
Not so fast!? Documenting by
|
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? |
Would it be ok to replace cargo/src/cargo/util/config.rs Line 153 in d8f066e
|
One can use the code in AFAICS it's the result of |
Makes sense. Going to raise a follow-up PR for this. Thanks! |
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 :) |
@dwijnand Should we truncate the path if it exceeds a certain length? |
Both https://doc.rust-lang.org/stable/cargo/reference/config.html?highlight=$HOME#hierarchical-structure and https://doc.rust-lang.org/stable/cargo/reference/environment-variables.html?highlight=$HOME#environment-variables-cargo-sets-for-crates make reference to |
Seems fine by me then. Thank you! |
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)
Fixes #4417