docs: More information on what is and isn't included by cargo package #14684
Conversation
rustbot
added
A-documenting-cargo-itself
|
r? @weihanglo |
|
The failures seem to be unrelated flakes? |
|
Perhaps we need to purchase some credits from Docker? 😬
Or we could switch to other image registry services |
|
https://github.com/rust-lang/cargo/actions/runs/11330170805/job/31507413375?pr=14684 Perhaps this is getting rate-limited based on the GitHub workers IP pool, if the cargo build does not currently pass any credentials? If so, just switching to an authenticated pull, even without paying, might help. It also might be possible to cache the image in GitHub Actions, per https://docs.docker.com/build/ci/github-actions/cache/. That would help stay below the limit of authenticated pulls. Even if we're using just the GitHub IPs it would probably reduce the error rate. We could split out a separate issue? I can have a look if you like, although as I'm not a project member I might need help with registering an account or uploading secrets. |
Blocked on #14686. |
Co-authored-by: Weihang Lo <weihanglo@users.noreply.github.com>
|
Thank you! @bors r+ |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
Update cargo 14 commits in 15fbd2f607d4defc87053b8b76bf5038f2483cf4..8c30ce53688e25f7e9d860b33cc914fb2957ca9a 2024-10-08 21:08:11 +0000 to 2024-10-15 16:43:16 +0000 - docs: More information on what is and isn't included by cargo package (rust-lang/cargo#14684) - fix(resolver): share conflict cache between activation retries (rust-lang/cargo#14692) - fix(git): dont fetch tags by default (rust-lang/cargo#14688) - Support package selection options like `--exclude` in `cargo publish` (rust-lang/cargo#14659) - docs: install options -> uninstall options (rust-lang/cargo#14682) - docs: tools should only interpret a line starting with `{` as JSON (rust-lang/cargo#14677) - cargo test --help: clarify --tests and --benches (rust-lang/cargo#14675) - docs(env): minor improvements in environment variables doc (rust-lang/cargo#14676) - docs: document official external commands (rust-lang/cargo#14669) - Fix panic when running cargo tree on a package with a cross compiled bindep (rust-lang/cargo#14593) - Remove the support for `Cargo.toml` of the cargo-script (rust-lang/cargo#14670) - docs(resolver): Lay groundwork for documenting MSRV-aware logic (rust-lang/cargo#14662) - chore(deps): update rust crate pulldown-cmark to 0.12.0 (rust-lang/cargo#14668) - Improve resolver speed (rust-lang/cargo#14663)
Update cargo 14 commits in 15fbd2f607d4defc87053b8b76bf5038f2483cf4..8c30ce53688e25f7e9d860b33cc914fb2957ca9a 2024-10-08 21:08:11 +0000 to 2024-10-15 16:43:16 +0000 - docs: More information on what is and isn't included by cargo package (rust-lang/cargo#14684) - fix(resolver): share conflict cache between activation retries (rust-lang/cargo#14692) - fix(git): dont fetch tags by default (rust-lang/cargo#14688) - Support package selection options like `--exclude` in `cargo publish` (rust-lang/cargo#14659) - docs: install options -> uninstall options (rust-lang/cargo#14682) - docs: tools should only interpret a line starting with `{` as JSON (rust-lang/cargo#14677) - cargo test --help: clarify --tests and --benches (rust-lang/cargo#14675) - docs(env): minor improvements in environment variables doc (rust-lang/cargo#14676) - docs: document official external commands (rust-lang/cargo#14669) - Fix panic when running cargo tree on a package with a cross compiled bindep (rust-lang/cargo#14593) - Remove the support for `Cargo.toml` of the cargo-script (rust-lang/cargo#14670) - docs(resolver): Lay groundwork for documenting MSRV-aware logic (rust-lang/cargo#14662) - chore(deps): update rust crate pulldown-cmark to 0.12.0 (rust-lang/cargo#14668) - Improve resolver speed (rust-lang/cargo#14663)
What does this PR try to resolve?
Add more detail to
cargo packageexplaining what is and isn't included.This doesn't add the feature requested by #11203 (shipping symlinks) but it does at least make it more clear that it's not supported.
How should we test and review this PR?
Docs only change.
I wrote this by reading src/cargo/sources/path.rs, in addition to my observations of cargo behavior, so it might be helpful for reviewers to check the new docs against the code.