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

guide: add section about the cargo home #7314

Merged
merged 1 commit into from
Sep 5, 2019
Merged

guide: add section about the cargo home #7314

merged 1 commit into from
Sep 5, 2019

Conversation

matthiaskrgr
Copy link
Member

@matthiaskrgr matthiaskrgr commented Aug 30, 2019 •
edited
Loading

This PR adds a section about the $CARGO_HOME to the cargo guide.

Rendered

@rust-highfive
Copy link

r? @alexcrichton

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 30, 2019
@ehuss
Copy link
Contributor

ehuss commented Aug 31, 2019

Thanks!

I'm not sure we want to explicitly document things like git and registry, since these are internal details of cargo, and may change over time without any sort of compatibility guarantees. I'd like to hear what others think, though.

@matthiaskrgr
Copy link
Member Author

Note that git and registry are already roughly documented in the manpage
https://github.com/rust-lang/cargo/blob/master/src/etc/man/cargo.1#L375

@alexcrichton
Copy link
Member

I agree that we don't want to provide any guarantees about the layout of CARGO_HOME. Saying though that the documentation is subject to change and this is just the current state of affairs is probably fine though, it's always interesting to poke around internal implementation details!

If the manpage needs to be updated to align with this then it'd be great if this could update the manpage as well!

@matthiaskrgr matthiaskrgr force-pushed the cargo_home_doc branch 3 times, most recently from c1a3e9e to bf56b20 Compare September 5, 2019 05:03
@matthiaskrgr
Copy link
Member Author

I added notes that the structure of the cache is not stabilized yet.
Let me know if there is anything else that needs improvement.

@matthiaskrgr matthiaskrgr changed the title [wip] guide: add section about cargo home guide: add section about the cargo home Sep 5, 2019
@matthiaskrgr matthiaskrgr marked this pull request as ready for review September 5, 2019 05:10
@alexcrichton
Copy link
Member

@bors: r+

@bors
Copy link
Contributor

bors commented Sep 5, 2019

📌 Commit 2e10986 has been approved by alexcrichton

@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 Sep 5, 2019
@bors
Copy link
Contributor

bors commented Sep 5, 2019

⌛ Testing commit 2e10986 with merge 4dfc693...

bors added a commit that referenced this pull request Sep 5, 2019
@bors
Auto merge of #7314 - matthiaskrgr:cargo_home_doc, r=alexcrichton
4dfc693 
guide: add section about the cargo home

This PR adds a section about the $CARGO_HOME to the cargo guide.

[Rendered](https://github.com/matthiaskrgr/cargo/blob/cargo_home_doc/src/doc/src/guide/cargo-home.md)
@bors
Copy link
Contributor

bors commented Sep 5, 2019

☀️ Test successful - checks-azure
Approved by: alexcrichton
Pushing 4dfc693 to master...

@bors bors merged commit 2e10986 into rust-lang:master Sep 5, 2019
@ehuss ehuss mentioned this pull request Sep 10, 2019
Merged
bors added a commit to rust-lang/rust that referenced this pull request Sep 13, 2019
@bors
Auto merge of #64361 - ehuss:update-cargo, r=alexcrichton
f43ac06 
Update cargo

11 commits in fe0e5a48b75da2b405c8ce1ba2674e174ae11d5d..9655d70af8a6dddac238e3afa2fec75088c9226f
2019-09-04 00:51:27 +0000 to 2019-09-10 18:16:11 +0000
- Home docs: fix broken links, misspellings, style fixes, clarifications. (rust-lang/cargo#7348)
- add readme key to cargos manifest. (rust-lang/cargo#7347)
- Explicitly ignore some results (rust-lang/cargo#7340)
- Don't resolve std's optional dependencies (rust-lang/cargo#7337)
- Add `alloc` and `proc_macro` to libstd crates (rust-lang/cargo#7336)
- doc: capitalization change for consistency. (rust-lang/cargo#7334)
- Fix test for changes in plugin API. (rust-lang/cargo#7335)
- Fix some man pages where the files weren't rebuilt. (rust-lang/cargo#7332)
- guide: add section about the cargo home (rust-lang/cargo#7314)
- `map_dependencies` is doing a deep clone, so lets make it cheaper (rust-lang/cargo#7326)
- don't need to copy this string (rust-lang/cargo#7324)
@ehuss ehuss added this to the 1.39.0 milestone Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@alexcrichton alexcrichton

Labels
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.39.0
Development

Successfully merging this pull request may close these issues.
5 participants
@matthiaskrgr @rust-highfive @ehuss @alexcrichton @bors