Auto merge of #10755 - jonhoo:stabilize-config-cli, r=ehuss

Stabilize config-cli

This stabilizes the `--config` CLI argument as per [this FCP](#7722 (comment)).

It also makes the adjustment [suggested by `@ehuss](#7722 (comment) to allow stabilizing `--config path` without _also_ stabilizing [`config-include`](https://doc.rust-lang.org/cargo/reference/unstable.html#config-include).

I took a guess that this would land in 1.63 and put that in the tombstone entry in the unstable docs, but let me know if that's likely to be wrong.

Closes #7722.

Also, I think this should probably be tagged `relnotes`.

src/bin/cargo/cli.rs

@@ -476,14 +476,7 @@ See 'cargo help <command>' for more information on a specific command.\n",
         .arg(flag("frozen", "Require Cargo.lock and cache are up to date").global(true))
         .arg(flag("locked", "Require Cargo.lock is up to date").global(true))
         .arg(flag("offline", "Run without accessing the network").global(true))
-        .arg(
-            multi_opt(
-                "config",
-                "KEY=VALUE",
-                "Override a configuration value (unstable)",
-            )
-            .global(true),
-        )
+        .arg(multi_opt("config", "KEY=VALUE", "Override a configuration value").global(true))
         .arg(
             Arg::new("unstable-features")
                 .help("Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for details")

src/cargo/util/config/mod.rs

@@ -892,7 +892,6 @@ impl Config {
             self.unstable_flags_cli = Some(unstable_flags.to_vec());
         }
         if !cli_config.is_empty() {
-            self.unstable_flags.fail_if_stable_opt("--config", 6699)?;
             self.cli_config = Some(cli_config.iter().map(|s| s.to_string()).collect());
             self.merge_cli_args()?;
         }
@@ -1165,6 +1164,7 @@ impl Config {
             Some(cli_args) => cli_args,
             None => return Ok(loaded_args),
         };
+        let mut seen = HashSet::new();
         for arg in cli_args {
             let arg_as_path = self.cwd.join(arg);
             let tmp_table = if !arg.is_empty() && arg_as_path.exists() {
@@ -1175,9 +1175,8 @@ impl Config {
                         anyhow::format_err!("config path {:?} is not utf-8", arg_as_path)
                     })?
                     .to_string();
-                let value = CV::String(str_path, Definition::Cli);
-                let map = HashMap::from([("include".to_string(), value)]);
-                CV::Table(map, Definition::Cli)
+                self._load_file(&self.cwd().join(&str_path), &mut seen, true)
+                    .with_context(|| format!("failed to load config from `{}`", str_path))?
             } else {
                 // We only want to allow "dotted key" (see https://toml.io/en/v1.0.0#keys)
                 // expressions followed by a value that's not an "inline table"

src/doc/man/generated_txt/cargo-add.txt

@@ -141,6 +141,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-bench.txt

@@ -353,6 +353,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-build.txt

@@ -302,6 +302,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-check.txt

@@ -287,6 +287,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-clean.txt

@@ -118,6 +118,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-doc.txt

@@ -258,6 +258,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-fetch.txt

@@ -103,6 +103,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-fix.txt

@@ -360,6 +360,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-generate-lockfile.txt

@@ -79,6 +79,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-init.txt

@@ -87,6 +87,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-install.txt

@@ -323,6 +323,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-locate-project.txt

@@ -62,6 +62,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-login.txt

@@ -62,6 +62,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-metadata.txt

@@ -391,6 +391,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-new.txt

@@ -82,6 +82,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-owner.txt

@@ -89,6 +89,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-package.txt

@@ -227,6 +227,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-pkgid.txt

@@ -109,6 +109,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-publish.txt

@@ -194,6 +194,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-run.txt

@@ -203,6 +203,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-rustc.txt

@@ -291,6 +291,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-rustdoc.txt

@@ -274,6 +274,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-search.txt

@@ -59,6 +59,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-test.txt

@@ -371,6 +371,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-tree.txt

@@ -269,6 +269,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-uninstall.txt

@@ -71,6 +71,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-update.txt

@@ -109,6 +109,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-vendor.txt

@@ -105,6 +105,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-verify-project.txt

@@ -82,6 +82,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo-yank.txt

@@ -85,6 +85,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/generated_txt/cargo.txt

@@ -188,6 +188,9 @@ OPTIONS
            <https://rust-lang.github.io/rustup/overrides.html> for more
            information about how toolchain overrides work.
 
+       --config KEY=VALUE
+           Overrides a Cargo configuration value.
+
        -h, --help
            Prints help information.
 

src/doc/man/includes/section-options-common.md

@@ -10,6 +10,10 @@ See the [rustup documentation](https://rust-lang.github.io/rustup/overrides.html
 for more information about how toolchain overrides work.
 {{/option}}
 
+{{#option "`--config` KEY=VALUE"}}
+Overrides a Cargo configuration value.
+{{/option}}
+
 {{#option "`-h`" "`--help`"}}
 Prints help information.
 {{/option}}

src/doc/src/commands/cargo-add.md

@@ -177,6 +177,10 @@ See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup docum
 for more information about how toolchain overrides work.</dd>
 
 
+<dt class="option-term" id="option-cargo-add---config"><a class="option-anchor" href="#option-cargo-add---config"></a><code>--config</code> KEY=VALUE</dt>
+<dd class="option-desc">Overrides a Cargo configuration value.</dd>
+
+
 <dt class="option-term" id="option-cargo-add--h"><a class="option-anchor" href="#option-cargo-add--h"></a><code>-h</code></dt>
 <dt class="option-term" id="option-cargo-add---help"><a class="option-anchor" href="#option-cargo-add---help"></a><code>--help</code></dt>
 <dd class="option-desc">Prints help information.</dd>

src/doc/src/commands/cargo-bench.md

@@ -420,6 +420,10 @@ See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup docum
 for more information about how toolchain overrides work.</dd>
 
 
+<dt class="option-term" id="option-cargo-bench---config"><a class="option-anchor" href="#option-cargo-bench---config"></a><code>--config</code> KEY=VALUE</dt>
+<dd class="option-desc">Overrides a Cargo configuration value.</dd>
+
+
 <dt class="option-term" id="option-cargo-bench--h"><a class="option-anchor" href="#option-cargo-bench--h"></a><code>-h</code></dt>
 <dt class="option-term" id="option-cargo-bench---help"><a class="option-anchor" href="#option-cargo-bench---help"></a><code>--help</code></dt>
 <dd class="option-desc">Prints help information.</dd>

src/doc/src/commands/cargo-build.md

@@ -364,6 +364,10 @@ See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup docum
 for more information about how toolchain overrides work.</dd>
 
 
+<dt class="option-term" id="option-cargo-build---config"><a class="option-anchor" href="#option-cargo-build---config"></a><code>--config</code> KEY=VALUE</dt>
+<dd class="option-desc">Overrides a Cargo configuration value.</dd>
+
+
 <dt class="option-term" id="option-cargo-build--h"><a class="option-anchor" href="#option-cargo-build--h"></a><code>-h</code></dt>
 <dt class="option-term" id="option-cargo-build---help"><a class="option-anchor" href="#option-cargo-build---help"></a><code>--help</code></dt>
 <dd class="option-desc">Prints help information.</dd>