Include vcs_info even if workspace is dirty by torhovland · Pull Request #13960 · rust-lang/cargo (original) (raw)

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

What does this PR try to resolve?

Related to #13695.

Generates and packages the .cargo_vcs_info.json file even if the worktree is dirty, as long as --allow-dirty is passed.

Also added a dirty field to the file to record if the Git repository status is dirty.

Tests are included.

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Choose a reason for hiding this comment

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

Thanks for the contribution. Could you adjust the commit order a bit?

The first commit adding a new test (issue_13695_dirty_vcs_info) to show the old behavior, and should pass the CI pipeline. The next commits fix both the behavior and test assertions.

@rfcbot fcp merge

With this change, the .cargo_vcs_info.json will always be generated regardless the dirty status of the VCS.

One risk is that people may already rely on the existence of vcs info file to determine if the repository is dirty. That's actually documented in the cargo-package manpage. However, a package without .cargo_vcs_info.json only implies that it was packaged with --allow-dirty passed, but not the repository was actually dirty at that time. Hence I think the risk should be low, and this patch makes it more accurate.

@rfcbot concern doc-update

Since we are going to include VCS info file unconditionally if in a Git repository, this might give people a false impression that Cargo handles package publish provenance against the linked repository. We may want to explicitly call out that Cargo hasn't yet provided the feature in the manpage, as people can fake the file. We should update the doc of the JSON format as well, and add a line saying that new fields may be added in the future and not considered as breaking changes.

@torhovland I've posted #13984 to address the concern. If that is merged, would you mind adjusting the doc here and adding a line about the new dirty field below this line?

One risk is that people may already rely on the existence of vcs info file to determine if the repository is dirty.

FYI crates.io is parsing this file these days. might be good to at least ping the crates.io team on semantic changes like this 😉

Thanks for letting us know, @Turbo87!

Does this change make sense to crates.io?

Does this change make sense to crates.io?

yeah, should be fine now that we know about it and can treat the new field correctly :)

FYI crates.io is parsing this file these days. might be good to at least ping the crates.io team on semantic changes like this 😉

When I saw Adam's blogpost, I informed him of this. That wasn't yet "crates.io is parsing" though. Was the use of this previously communicated in some other way so we would know to tell crates.io?

🔔 This is now entering its final comment period, as per the review above. 🔔

📌 Commit e7bfed1 has been approved by weihanglo

It is now in the queue for this repository.

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-author

Status: The marked PR is awaiting some action (such as code changes) from the PR author.

labels

Jun 24, 2024

bors mentioned this pull request

Jun 24, 2024

bors added a commit to rust-lang-ci/rust that referenced this pull request

Jun 25, 2024

bors added a commit to rust-lang-ci/rust that referenced this pull request

Jun 25, 2024

bors added a commit to rust-lang-ci/rust that referenced this pull request

Jun 25, 2024

bors added a commit to rust-lang-ci/rust that referenced this pull request

Jun 26, 2024

flip1995 pushed a commit to flip1995/rust-clippy that referenced this pull request

Jun 28, 2024

tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request

Sep 11, 2024

This MR contains the following updates:

Package	Update	Change
rust	minor	`1.80.1` -> `1.81.0`

MR created with the help of el-capitano/tools/renovate-bot.

Proposed changes to behavior should be submitted there as MRs.

Release Notes

rust-lang/rust (rust)

`v1.81.0`

Compare Source

==========================

Language

Compiler

Make casts of pointers to trait objects stricter.
Check alias args for well-formedness even if they have escaping bound vars.
Deprecate no-op codegen option -Cinline-threshold=....
Re-implement a type-size based limit.
Properly account for alignment in transmute size checks.
Remove the box_pointers lint.
Ensure the interpreter checks bool/char for validity when they are used in a cast.
Improve coverage instrumentation for functions containing nested items.
Target changes:
- Add Tier 3 no_std Xtensa targets: xtensa-esp32-none-elf, xtensa-esp32s2-none-elf, xtensa-esp32s3-none-elf
- Add Tier 3 std Xtensa targets: xtensa-esp32-espidf, xtensa-esp32s2-espidf, xtensa-esp32s3-espidf
- Add Tier 3 i686 Redox OS target: i686-unknown-redox
- Promote arm64ec-pc-windows-msvc to Tier 2.
- Promote loongarch64-unknown-linux-musl to Tier 2 with host tools.
- Enable full tools and profiler for LoongArch Linux targets.
- Unconditionally warn on usage of wasm32-wasi. (see compatibility note below)
- Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support.

Libraries

Split core's PanicInfo and std's PanicInfo. (see compatibility note below)
Generalize {Rc,Arc}::make_mut() to unsized types.
Replace sort implementations with stable driftsort and unstable ipnsort. All slice::sort* and slice::select_nth* methods are expected to see significant performance improvements. See the research project for more details.
Document behavior of create_dir_all with respect to empty paths.
Fix interleaved output in the default panic hook when multiple threads panic simultaneously.

Stabilized APIs

These APIs are now stable in const contexts:

Cargo

Compatibility Notes

Usage of the wasm32-wasi target will now issue a compiler warning and request users switch to the wasm32-wasip1 target instead. Both targets are the same, wasm32-wasi is only being renamed, and this change to the WASI target is being done to enable removing wasm32-wasi in January 2025.
We have renamed std::panic::PanicInfo to std::panic::PanicHookInfo. The old name will continue to work as an alias, but will result in a deprecation warning starting in Rust 1.82.0.

core::panic::PanicInfo will remain unchanged, however, as this is now a different type.

The reason is that these types have different roles: std::panic::PanicHookInfo is the argument to the panic hook in std context (where panics can have an arbitrary payload), while core::panic::PanicInfo is the argument to the #[panic_handler] in no_std context (where panics always carry a formatted message). Separating these types allows us to add more useful methods to these types, such as std::panic::PanicHookInfo::payload_as_str() and core::panic::PanicInfo::message().
The new sort implementations may panic if a type's implementation of Ord (or the given comparison function) does not implement a total order as the trait requires. Ord's supertraits (PartialOrd, Eq, and PartialEq) must also be consistent. The previous implementations would not "notice" any problem, but the new implementations have a good chance of detecting inconsistencies, throwing a panic rather than returning knowingly unsorted data.
In very rare cases, a change in the internal evaluation order of the trait solver may result in new fatal overflow errors.

Internal Changes

These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools.

Add a Rust-for Linux auto CI job to check kernel builds.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

wip-sync pushed a commit to NetBSD/pkgsrc-wip that referenced this pull request

Sep 22, 2024

Pkgsrc changes:

Adapt patches, apply to new vendored crates where needed.
Back-port rust pull request 130110, "make dist vendoring configurable"
Disable "dist vendoring", otherwise cargo would try to access the network during the build phase.

Upstream changes:

Version 1.81.0 (2024-09-05)

Language

[Abort on uncaught panics in extern "C" functions.] (rust-lang/rust#116088)
[Fix ambiguous cases of multiple & in elided self lifetimes.] (rust-lang/rust#117967)
[Stabilize #[expect] for lints (RFC 2383),] (rust-lang/rust#120924) like #[allow] with a warning if the lint is not fulfilled.
[Change method resolution to constrain hidden types instead of rejecting method candidates.] (rust-lang/rust#123962)
[Bump elided_lifetimes_in_associated_constant to deny.] (rust-lang/rust#124211)
[offset_from: always allow pointers to point to the same address.] (rust-lang/rust#124921)
[Allow constraining opaque types during subtyping in the trait system.] (rust-lang/rust#125447)
[Allow constraining opaque types during various unsizing casts.] (rust-lang/rust#125610)
[Deny keyword lifetimes pre-expansion.] (rust-lang/rust#126762)

Compiler

[Make casts of pointers to trait objects stricter.] (rust-lang/rust#120248)
[Check alias args for well-formedness even if they have escaping bound vars.] (rust-lang/rust#123737)
[Deprecate no-op codegen option -Cinline-threshold=....] (rust-lang/rust#124712)
[Re-implement a type-size based limit.] (rust-lang/rust#125507)
[Properly account for alignment in transmute size checks.] (rust-lang/rust#125740)
[Remove the box_pointers lint.] (rust-lang/rust#126018)
[Ensure the interpreter checks bool/char for validity when they are used in a cast.] (rust-lang/rust#126265)
[Improve coverage instrumentation for functions containing nested items.] (rust-lang/rust#127199)
Target changes:
- [Add Tier 3 no_std Xtensa targets:] (rust-lang/rust#125141) xtensa-esp32-none-elf, xtensa-esp32s2-none-elf, xtensa-esp32s3-none-elf
- [Add Tier 3 std Xtensa targets:] (rust-lang/rust#126380) xtensa-esp32-espidf, xtensa-esp32s2-espidf, xtensa-esp32s3-espidf
- [Add Tier 3 i686 Redox OS target:] (rust-lang/rust#126192) i686-unknown-redox
- [Promote arm64ec-pc-windows-msvc to Tier 2.] (rust-lang/rust#126039)
- [Promote wasm32-wasip2 to Tier 2.] (rust-lang/rust#126967)
- [Promote loongarch64-unknown-linux-musl to Tier 2 with host tools.] (rust-lang/rust#126298)
- [Enable full tools and profiler for LoongArch Linux targets.] (rust-lang/rust#127078)
- [Unconditionally warn on usage of wasm32-wasi.] (rust-lang/rust#126662) (see compatibility note below)
- Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support.

Libraries

[Split core's PanicInfo and std's PanicInfo.] (rust-lang/rust#115974) (see compatibility note below)
[Generalize {Rc,Arc}::make_mut() to unsized types.] (rust-lang/rust#116113)
[Replace sort implementations with stable driftsort and unstable ipnsort.] (rust-lang/rust#124032) All slice::sort* and slice::select_nth* methods are expected to see significant performance improvements. See the [research project] (https://github.com/Voultapher/sort-research-rs) for more details.
[Document behavior of create_dir_all with respect to empty paths.] (rust-lang/rust#125112)
[Fix interleaved output in the default panic hook when multiple threads panic simultaneously.] (rust-lang/rust#127397)
Fix Command's batch files argument escaping not working when file name has trailing whitespace or periods (CVE-2024-43402).

Stabilized APIs

[core::error] (https://doc.rust-lang.org/stable/core/error/index.html)
[hint::assert_unchecked] (https://doc.rust-lang.org/stable/core/hint/fn.assert_unchecked.html)
[fs::exists] (https://doc.rust-lang.org/stable/std/fs/fn.exists.html)
[AtomicBool::fetch_not] (https://doc.rust-lang.org/stable/core/sync/atomic/struct.AtomicBool.html#method.fetch_not)
[Duration::abs_diff] (https://doc.rust-lang.org/stable/core/time/struct.Duration.html#method.abs_diff)
[IoSlice::advance] (https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.advance)
[IoSlice::advance_slices] (https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.advance_slices)
[IoSliceMut::advance] (https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.advance)
[IoSliceMut::advance_slices] (https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.advance_slices)
[PanicHookInfo] (https://doc.rust-lang.org/stable/std/panic/struct.PanicHookInfo.html)
[PanicInfo::message] (https://doc.rust-lang.org/stable/core/panic/struct.PanicInfo.html#method.message)
[PanicMessage] (https://doc.rust-lang.org/stable/core/panic/struct.PanicMessage.html)

These APIs are now stable in const contexts:

[char::from_u32_unchecked] (https://doc.rust-lang.org/stable/core/char/fn.from_u32_unchecked.html) (function)
[char::from_u32_unchecked] (https://doc.rust-lang.org/stable/core/primitive.char.html#method.from_u32_unchecked) (method)
[CStr::count_bytes] (https://doc.rust-lang.org/stable/core/ffi/c_str/struct.CStr.html#method.count_bytes)
[CStr::from_ptr] (https://doc.rust-lang.org/stable/core/ffi/c_str/struct.CStr.html#method.from_ptr)

Cargo

[Generated .cargo_vcs_info.json is always included, even when --allow-dirty is passed.] (rust-lang/cargo#13960)
[Disallow package.license-file and package.readme pointing to non-existent files during packaging.] (rust-lang/cargo#13921)
[Disallow passing --release/--debug flag along with the --profile flag.] (rust-lang/cargo#13971)
[Remove lib.plugin key support in Cargo.toml. Rust plugin support has been deprecated for four years and was removed in 1.75.0.] (rust-lang/cargo#13902)

Compatibility Notes

Usage of the wasm32-wasi target will now issue a compiler warning and request users switch to the wasm32-wasip1 target instead. Both targets are the same, wasm32-wasi is only being renamed, and this [change to the WASI target] (https://blog.rust-lang.org/2024/04/09/updates-to-rusts-wasi-targets.html) is being done to enable removing wasm32-wasi in January 2025.
We have renamed std::panic::PanicInfo to std::panic::PanicHookInfo. The old name will continue to work as an alias, but will result in a deprecation warning starting in Rust 1.82.0.

core::panic::PanicInfo will remain unchanged, however, as this is now a different type.

The reason is that these types have different roles: std::panic::PanicHookInfo is the argument to the panic hook in std context (where panics can have an arbitrary payload), while core::panic::PanicInfo is the argument to the #[panic_handler] in no_std context (where panics always carry a formatted message). Separating these types allows us to add more useful methods to these types, such as std::panic::PanicHookInfo::payload_as_str() and core::panic::PanicInfo::message().
The new sort implementations may panic if a type's implementation of Ord (or the given comparison function) does not implement a total order as the trait requires. Ord's supertraits (PartialOrd, Eq, and PartialEq) must also be consistent. The previous implementations would not "notice" any problem, but the new implementations have a good chance of detecting inconsistencies, throwing a panic rather than returning knowingly unsorted data.
[In very rare cases, a change in the internal evaluation order of the trait solver may result in new fatal overflow errors.] (rust-lang/rust#126128)

Internal Changes

These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools.

[Add a Rust-for Linux auto CI job to check kernel builds.] (rust-lang/rust#125209)

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request

Nov 24, 2024

Pkgsrc changes:

Adapt patches, apply to new vendored crates where needed.
Back-port rust pull request 130110, "make dist vendoring configurable"
Disable "dist vendoring", otherwise cargo would try to access the network during the build phase.

Upstream changes:

Version 1.81.0 (2024-09-05)

Language

[Abort on uncaught panics in extern "C" functions.] (rust-lang/rust#116088)
[Fix ambiguous cases of multiple & in elided self lifetimes.] (rust-lang/rust#117967)
[Stabilize #[expect] for lints (RFC 2383),] (rust-lang/rust#120924) like #[allow] with a warning if the lint is not fulfilled.
[Change method resolution to constrain hidden types instead of rejecting method candidates.] (rust-lang/rust#123962)
[Bump elided_lifetimes_in_associated_constant to deny.] (rust-lang/rust#124211)
[offset_from: always allow pointers to point to the same address.] (rust-lang/rust#124921)
[Allow constraining opaque types during subtyping in the trait system.] (rust-lang/rust#125447)
[Allow constraining opaque types during various unsizing casts.] (rust-lang/rust#125610)
[Deny keyword lifetimes pre-expansion.] (rust-lang/rust#126762)

Compiler

[Make casts of pointers to trait objects stricter.] (rust-lang/rust#120248)
[Check alias args for well-formedness even if they have escaping bound vars.] (rust-lang/rust#123737)
[Deprecate no-op codegen option -Cinline-threshold=....] (rust-lang/rust#124712)
[Re-implement a type-size based limit.] (rust-lang/rust#125507)
[Properly account for alignment in transmute size checks.] (rust-lang/rust#125740)
[Remove the box_pointers lint.] (rust-lang/rust#126018)
[Ensure the interpreter checks bool/char for validity when they are used in a cast.] (rust-lang/rust#126265)
[Improve coverage instrumentation for functions containing nested items.] (rust-lang/rust#127199)
Target changes:
- [Add Tier 3 no_std Xtensa targets:] (rust-lang/rust#125141) xtensa-esp32-none-elf, xtensa-esp32s2-none-elf, xtensa-esp32s3-none-elf
- [Add Tier 3 std Xtensa targets:] (rust-lang/rust#126380) xtensa-esp32-espidf, xtensa-esp32s2-espidf, xtensa-esp32s3-espidf
- [Add Tier 3 i686 Redox OS target:] (rust-lang/rust#126192) i686-unknown-redox
- [Promote arm64ec-pc-windows-msvc to Tier 2.] (rust-lang/rust#126039)
- [Promote wasm32-wasip2 to Tier 2.] (rust-lang/rust#126967)
- [Promote loongarch64-unknown-linux-musl to Tier 2 with host tools.] (rust-lang/rust#126298)
- [Enable full tools and profiler for LoongArch Linux targets.] (rust-lang/rust#127078)
- [Unconditionally warn on usage of wasm32-wasi.] (rust-lang/rust#126662) (see compatibility note below)
- Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support.

Libraries

[Split core's PanicInfo and std's PanicInfo.] (rust-lang/rust#115974) (see compatibility note below)
[Generalize {Rc,Arc}::make_mut() to unsized types.] (rust-lang/rust#116113)
[Replace sort implementations with stable driftsort and unstable ipnsort.] (rust-lang/rust#124032) All slice::sort* and slice::select_nth* methods are expected to see significant performance improvements. See the [research project] (https://github.com/Voultapher/sort-research-rs) for more details.
[Document behavior of create_dir_all with respect to empty paths.] (rust-lang/rust#125112)
[Fix interleaved output in the default panic hook when multiple threads panic simultaneously.] (rust-lang/rust#127397)
Fix Command's batch files argument escaping not working when file name has trailing whitespace or periods (CVE-2024-43402).

Stabilized APIs

[core::error] (https://doc.rust-lang.org/stable/core/error/index.html)
[hint::assert_unchecked] (https://doc.rust-lang.org/stable/core/hint/fn.assert_unchecked.html)
[fs::exists] (https://doc.rust-lang.org/stable/std/fs/fn.exists.html)
[AtomicBool::fetch_not] (https://doc.rust-lang.org/stable/core/sync/atomic/struct.AtomicBool.html#method.fetch_not)
[Duration::abs_diff] (https://doc.rust-lang.org/stable/core/time/struct.Duration.html#method.abs_diff)
[IoSlice::advance] (https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.advance)
[IoSlice::advance_slices] (https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.advance_slices)
[IoSliceMut::advance] (https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.advance)
[IoSliceMut::advance_slices] (https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.advance_slices)
[PanicHookInfo] (https://doc.rust-lang.org/stable/std/panic/struct.PanicHookInfo.html)
[PanicInfo::message] (https://doc.rust-lang.org/stable/core/panic/struct.PanicInfo.html#method.message)
[PanicMessage] (https://doc.rust-lang.org/stable/core/panic/struct.PanicMessage.html)

These APIs are now stable in const contexts:

[char::from_u32_unchecked] (https://doc.rust-lang.org/stable/core/char/fn.from_u32_unchecked.html) (function)
[char::from_u32_unchecked] (https://doc.rust-lang.org/stable/core/primitive.char.html#method.from_u32_unchecked) (method)
[CStr::count_bytes] (https://doc.rust-lang.org/stable/core/ffi/c_str/struct.CStr.html#method.count_bytes)
[CStr::from_ptr] (https://doc.rust-lang.org/stable/core/ffi/c_str/struct.CStr.html#method.from_ptr)

Cargo

[Generated .cargo_vcs_info.json is always included, even when --allow-dirty is passed.] (rust-lang/cargo#13960)
[Disallow package.license-file and package.readme pointing to non-existent files during packaging.] (rust-lang/cargo#13921)
[Disallow passing --release/--debug flag along with the --profile flag.] (rust-lang/cargo#13971)
[Remove lib.plugin key support in Cargo.toml. Rust plugin support has been deprecated for four years and was removed in 1.75.0.] (rust-lang/cargo#13902)

Compatibility Notes

Usage of the wasm32-wasi target will now issue a compiler warning and request users switch to the wasm32-wasip1 target instead. Both targets are the same, wasm32-wasi is only being renamed, and this [change to the WASI target] (https://blog.rust-lang.org/2024/04/09/updates-to-rusts-wasi-targets.html) is being done to enable removing wasm32-wasi in January 2025.
We have renamed std::panic::PanicInfo to std::panic::PanicHookInfo. The old name will continue to work as an alias, but will result in a deprecation warning starting in Rust 1.82.0.

core::panic::PanicInfo will remain unchanged, however, as this is now a different type.

The reason is that these types have different roles: std::panic::PanicHookInfo is the argument to the panic hook in std context (where panics can have an arbitrary payload), while core::panic::PanicInfo is the argument to the #[panic_handler] in no_std context (where panics always carry a formatted message). Separating these types allows us to add more useful methods to these types, such as std::panic::PanicHookInfo::payload_as_str() and core::panic::PanicInfo::message().
The new sort implementations may panic if a type's implementation of Ord (or the given comparison function) does not implement a total order as the trait requires. Ord's supertraits (PartialOrd, Eq, and PartialEq) must also be consistent. The previous implementations would not "notice" any problem, but the new implementations have a good chance of detecting inconsistencies, throwing a panic rather than returning knowingly unsorted data.
[In very rare cases, a change in the internal evaluation order of the trait solver may result in new fatal overflow errors.] (rust-lang/rust#126128)

Internal Changes

These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools.

[Add a Rust-for Linux auto CI job to check kernel builds.] (rust-lang/rust#125209)

epage mentioned this pull request

Dec 10, 2024

This was referenced

Dec 18, 2024