feat(config): Stabilize resolver.lockfile-path

Author: epage

src/cargo/core/features.rs

@@ -887,7 +887,6 @@ unstable_cli_options!(
     gitoxide: Option<GitoxideFeatures> = ("Use gitoxide for the given git interactions, or all of them if no argument is given"),
     host_config: bool = ("Enable the `[host]` section in the .cargo/config.toml file"),
     json_target_spec: bool = ("Enable `.json` target spec files"),
-    lockfile_path: bool = ("Enable the `resolver.lockfile-path` config option"),
     minimal_versions: bool = ("Resolve minimal dependency versions instead of maximum"),
     msrv_policy: bool = ("Enable rust-version aware policy within cargo"),
     mtime_on_use: bool = ("Configure Cargo to update the mtime of used files"),
@@ -1001,6 +1000,8 @@ const STABILIZED_BUILD_DIR: &str = "build.build-dir is now always enabled.";
 
 const STABILIZED_CONFIG_INCLUDE: &str = "The `include` config key is now always available";
 
+const STABILIZED_LOCKFILE_PATH: &str = "The `lockfile-path` config key is now always available";
+
 fn deserialize_comma_separated_list<'de, D>(
     deserializer: D,
 ) -> Result<Option<Vec<String>>, D::Error>
@@ -1389,6 +1390,7 @@ impl CliUnstable {
             "package-workspace" => stabilized_warn(k, "1.89", STABILIZED_PACKAGE_WORKSPACE),
             "build-dir" => stabilized_warn(k, "1.91", STABILIZED_BUILD_DIR),
             "config-include" => stabilized_warn(k, "1.93", STABILIZED_CONFIG_INCLUDE),
+            "lockfile-path" => stabilized_warn(k, "1.97", STABILIZED_LOCKFILE_PATH),
 
             // Unstable features
             // Sorted alphabetically:
@@ -1427,7 +1429,6 @@ impl CliUnstable {
             }
             "host-config" => self.host_config = parse_empty(k, v)?,
             "json-target-spec" => self.json_target_spec = parse_empty(k, v)?,
-            "lockfile-path" => self.lockfile_path = parse_empty(k, v)?,
             "next-lockfile-bump" => self.next_lockfile_bump = parse_empty(k, v)?,
             "minimal-versions" => self.minimal_versions = parse_empty(k, v)?,
             "msrv-policy" => self.msrv_policy = parse_empty(k, v)?,

src/cargo/core/workspace.rs

@@ -369,10 +369,9 @@ impl<'gctx> Workspace<'gctx> {
         };
 
         if let Some(lockfile_path) = config.lockfile_path {
-            if self.gctx().cli_unstable().lockfile_path {
-                // Reserve the ability to add templates in the future.
-                let replacements: [(&str, &str); 0] = [];
-                let path = lockfile_path
+            // Reserve the ability to add templates in the future.
+            let replacements: [(&str, &str); 0] = [];
+            let path = lockfile_path
                     .resolve_templated_path(self.gctx(), replacements)
                     .map_err(|e| match e {
                         context::ResolveTemplateError::UnexpectedVariable {
@@ -394,21 +393,16 @@ impl<'gctx> Workspace<'gctx> {
                             )
                         }
                     })?;
-                if !path.ends_with(LOCKFILE_NAME) {
-                    bail!("the `resolver.lockfile-path` must be a path to a {LOCKFILE_NAME} file");
-                }
-                if path.is_dir() {
-                    bail!(
-                        "`resolver.lockfile-path` `{}` is a directory but expected a file",
-                        path.display()
-                    );
-                }
-                self.requested_lockfile_path = Some(path);
-            } else {
-                self.gctx().shell().warn(
-                    "ignoring `resolver.lockfile-path`, pass `-Zlockfile-path` to enable it",
-                )?;
+            if !path.ends_with(LOCKFILE_NAME) {
+                bail!("the `resolver.lockfile-path` must be a path to a {LOCKFILE_NAME} file");
+            }
+            if path.is_dir() {
+                bail!(
+                    "`resolver.lockfile-path` `{}` is a directory but expected a file",
+                    path.display()
+                );
             }
+            self.requested_lockfile_path = Some(path);
         }
 
         Ok(())

src/doc/src/reference/config.md

@@ -149,6 +149,7 @@ rpath = false            # Sets the rpath linking option.
 # Same keys for a normal profile (minus `panic`, `lto`, and `rpath`).
 
 [resolver]
+lockfile-path = "…"  # Overrides the path used for
 incompatible-rust-versions = "allow"  # Specifies how resolver reacts to these
 
 [registries.<name>]  # registries other than crates.io
@@ -1101,6 +1102,18 @@ See [strip](profiles.md#strip).
 
 The `[resolver]` table overrides [dependency resolution behavior](resolver.md) for local development (e.g. excludes `cargo install`).
 
+#### `resolver.lockfile-path`
+* Type: string (path)
+* Default: `<workspace_root>/Cargo.lock`
+* Environment: `CARGO_RESOLVER_LOCKFILE_PATH`
+
+Specifies the path to the lockfile to use when resolving dependencies.
+This option is useful when working with read-only source directories.
+
+The path must end with `Cargo.lock`.
+
+> **MSRV:** Requires 1.97+
+
 #### `resolver.incompatible-rust-versions`
 * Type: string
 * Default: See [`resolver`](resolver.md#resolver-versions) docs

src/doc/src/reference/unstable.md

@@ -130,7 +130,6 @@ Each new feature described below should explain how to use it.
 * Other
     * [gitoxide](#gitoxide) --- Use `gitoxide` instead of `git2` for a set of operations.
     * [script](#script) --- Enable support for single-file `.rs` packages.
-    * [lockfile-path](#lockfile-path) --- Allows to specify a path to lockfile other than the default path `<workspace_root>/Cargo.lock`.
     * [native-completions](#native-completions) --- Move cargo shell completions to native completions.
     * [warnings](#warnings) --- controls warning behavior; options for allowing or denying warnings.
     * [Package message format](#package-message-format) --- Message format for `cargo package`.
@@ -1766,43 +1765,6 @@ will prefer the value in the configuration. The allows Cargo to add new built-in
 path bases without compatibility issues (as existing uses will shadow the
 built-in name).
 
-## lockfile-path
-
-* Original Issue: [#5707](https://github.com/rust-lang/cargo/issues/5707)
-* Tracking Issue: [#14421](https://github.com/rust-lang/cargo/issues/14421)
-
-The `-Zlockfile-path` flag enables the `resolver.lockfile-path` configuration option,
-which allows you to specify the path of the lockfile `Cargo.lock`.
-
-By default, lockfile is written into `<workspace_root>/Cargo.lock`. 
-However, when sources are stored in read-only directory,
-most of the cargo commands would fail when trying to write a lockfile.
-This configuration makes it easier to work with readonly sources. 
-
-Note, that currently path must end with `Cargo.lock`.
-If you want to use this feature in multiple projects,
-lockfiles should be stored in different directories.
-
-### Documentation updates
-
-*as a new `resolver.lockfile-path` entry in config.md*
-
-*Keep in mind, the `[resolver]` section has this clarification:*
-
-> *The `[resolver]` table overrides dependency resolution behavior for local development (e.g. excludes `cargo install`).*
-
-#### `resolver.lockfile-path`
-
-* Type: string (path)
-* Default: `<workspace_root>/Cargo.lock`
-* Environment: `CARGO_RESOLVER_LOCKFILE_PATH`
-
-Specifies the path to the lockfile.
-By default, the lockfile is written to `<workspace_root>/Cargo.lock`.
-This option is useful when working with read-only source directories.
-
-The path must end with `Cargo.lock`.
-
 ## native-completions
 * Original Issue: [#6645](https://github.com/rust-lang/cargo/issues/6645)
 * Tracking Issue: [#14520](https://github.com/rust-lang/cargo/issues/14520)
@@ -2353,3 +2315,7 @@ See the [`include` config documentation](config.md#include) for more.
 ## pubtime
 
 The `pubtime` index field  has been stabilized in Rust 1.94.0.
+
+## lockfile-path
+
+Support for `resolver.lockfile-path` config field has been stabilized in Rust 1.97.0.