itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #11095 - weihanglo:update-comment-resolveversion, r=epage

Browse Source 
Update comment about ResolveVersion default version

### What does this PR try to resolve?

Point out that the current `ResolveVersion` defaults to `V3`

### How should we test and review this PR?

- Introduced in 1.47.0 https://github.com/rust-lang/cargo/blob/rust-1.47.0/src/cargo/core/resolver/resolve.rs#L60-L73
- As default in 1.53.0 https://github.com/rust-lang/cargo/blob/rust-1.53.0/src/cargo/core/resolver/resolve.rs#L412

<!-- homu-ignore:end -->
This commit is contained in:
bors 2022-09-16 12:26:07 +00:00
commit ef7ab8bb62
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/cargo/core/resolver/resolve.rs
View File

@ -46,9 +46,11 @@ pub struct Resolve {
summaries: HashMap<PackageId, Summary>, summaries: HashMap<PackageId, Summary>,
} }
/// A version to indicate how a `Cargo.lock` should be serialized. Currently /// A version to indicate how a `Cargo.lock` should be serialized.
/// V2 is the default when creating a new lockfile. If a V1 lockfile already ///
/// exists, it will stay as V1. /// When creating a new lockfile, the default version defined in
/// [`ResolveVersion::default`] is used.
/// If an old version of lockfile already exists, it will stay as-is.
/// ///
/// It's theorized that we can add more here over time to track larger changes /// It's theorized that we can add more here over time to track larger changes
/// to the `Cargo.lock` format, but we've yet to see how that strategy pans out. /// to the `Cargo.lock` format, but we've yet to see how that strategy pans out.
@ -59,12 +61,13 @@ pub enum ResolveVersion {
/// A more compact format, more amenable to avoiding source-control merge /// A more compact format, more amenable to avoiding source-control merge
/// conflicts. The `dependencies` arrays are compressed and checksums are /// conflicts. The `dependencies` arrays are compressed and checksums are
/// listed inline. Introduced in 2019 in version 1.38. New lockfiles use /// listed inline. Introduced in 2019 in version 1.38. New lockfiles use
/// V2 by default starting in 1.41. /// V2 by default from 1.41 to 1.52.
V2, V2,
/// A format that explicitly lists a `version` at the top of the file as /// A format that explicitly lists a `version` at the top of the file as
/// well as changing how git dependencies are encoded. Dependencies with /// well as changing how git dependencies are encoded. Dependencies with
/// `branch = "master"` are no longer encoded the same way as those without /// `branch = "master"` are no longer encoded the same way as those without
/// branch specifiers. /// branch specifiers. Introduced in 2020 in version 1.47. New lockfiles use
/// V3 by default staring in 1.53.
V3, V3,
} }
@ -395,7 +398,7 @@ impl fmt::Debug for Resolve {
impl Default for ResolveVersion { impl Default for ResolveVersion {
/// The default way to encode new or updated `Cargo.lock` files. /// The default way to encode new or updated `Cargo.lock` files.
/// ///
/// It's important that if a new version of `ResolveVersion` is added that /// It's important that if a new version of [`ResolveVersion`] is added that
/// this is not updated until *at least* the support for the version is in /// this is not updated until *at least* the support for the version is in
/// the stable release of Rust. /// the stable release of Rust.
/// ///