Make --allow-dirty imply --allow-staged (#15013)

Staged changes don't really need protecting, and `--allow-dirty` is stronger than `--allow-staged`, so it can imply `--allow-staged` to make usage of `cargo fix` less verbose. Closes #14176
rust-lang · Jan 21, 2025 · 53a2fdf · 53a2fdf
2 parents 2668a4f + 973cd53
commit 53a2fdf
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 65 deletions.
diff --git a/src/bin/cargo/commands/fix.rs b/src/bin/cargo/commands/fix.rs
@@ -21,7 +21,7 @@ pub fn cli() -> Command {
         ))
         .arg(flag(
             "allow-dirty",
-            "Fix code even if the working directory is dirty",
+            "Fix code even if the working directory is dirty or has staged changes",
         ))
         .arg(flag(
             "allow-staged",
@@ -86,6 +86,8 @@ pub fn exec(gctx: &mut GlobalContext, args: &ArgMatches) -> CliResult {
         opts.filter = ops::CompileFilter::new_all_targets();
     }
 
+    let allow_dirty = args.flag("allow-dirty");
+
     ops::fix(
         gctx,
         &ws,
@@ -94,9 +96,9 @@ pub fn exec(gctx: &mut GlobalContext, args: &ArgMatches) -> CliResult {
             edition: args.flag("edition"),
             idioms: args.flag("edition-idioms"),
             compile_opts: opts,
-            allow_dirty: args.flag("allow-dirty"),
+            allow_dirty,
+            allow_staged: allow_dirty || args.flag("allow-staged"),
             allow_no_vcs: args.flag("allow-no-vcs"),
-            allow_staged: args.flag("allow-staged"),
             broken_code: args.flag("broken-code"),
             requested_lockfile_path: lockfile_path,
         },

diff --git a/src/cargo/ops/fix.rs b/src/cargo/ops/fix.rs
@@ -242,7 +242,7 @@ fn check_version_control(gctx: &GlobalContext, opts: &FixOptions) -> CargoResult
     bail!(
         "the working directory of this package has uncommitted changes, and \
          `cargo fix` can potentially perform destructive changes; if you'd \
-         like to suppress this error pass `--allow-dirty`, `--allow-staged`, \
+         like to suppress this error pass `--allow-dirty`, \
          or commit the changes to these files:\n\
          \n\
          {}\n\

diff --git a/src/doc/man/cargo-fix.md b/src/doc/man/cargo-fix.md
@@ -93,7 +93,7 @@ Fix code even if a VCS was not detected.
 {{/option}}
 
 {{#option "`--allow-dirty`" }}
-Fix code even if the working directory has changes.
+Fix code even if the working directory has changes (including staged changes).
 {{/option}}
 
 {{#option "`--allow-staged`" }}

diff --git a/src/doc/man/generated_txt/cargo-fix.txt b/src/doc/man/generated_txt/cargo-fix.txt
@@ -84,7 +84,8 @@ OPTIONS
            Fix code even if a VCS was not detected.
 
        --allow-dirty
-           Fix code even if the working directory has changes.
+           Fix code even if the working directory has changes (including staged
+           changes).
 
        --allow-staged
            Fix code even if the working directory has staged changes.

diff --git a/src/doc/src/commands/cargo-fix.md b/src/doc/src/commands/cargo-fix.md
@@ -89,7 +89,7 @@ edition.</dd>
 
 
 <dt class="option-term" id="option-cargo-fix---allow-dirty"><a class="option-anchor" href="#option-cargo-fix---allow-dirty"></a><code>--allow-dirty</code></dt>
-<dd class="option-desc">Fix code even if the working directory has changes.</dd>
+<dd class="option-desc">Fix code even if the working directory has changes (including staged changes).</dd>
 
 
 <dt class="option-term" id="option-cargo-fix---allow-staged"><a class="option-anchor" href="#option-cargo-fix---allow-staged"></a><code>--allow-staged</code></dt>

diff --git a/src/etc/man/cargo-fix.1 b/src/etc/man/cargo-fix.1
@@ -103,7 +103,7 @@ Fix code even if a VCS was not detected.
 .sp
 \fB\-\-allow\-dirty\fR
 .RS 4
-Fix code even if the working directory has changes.
+Fix code even if the working directory has changes (including staged changes).
 .RE
 .sp
 \fB\-\-allow\-staged\fR

diff --git a/tests/testsuite/cargo_fix/help/stdout.term.svg b/tests/testsuite/cargo_fix/help/stdout.term.svg
diff --git a/tests/testsuite/fix.rs b/tests/testsuite/fix.rs
@@ -635,7 +635,7 @@ fn warns_about_dirty_working_directory() {
     p.cargo("fix")
         .with_status(101)
         .with_stderr_data(str![[r#"
-[ERROR] the working directory of this package has uncommitted changes, and `cargo fix` can potentially perform destructive changes; if you'd like to suppress this error pass `--allow-dirty`, `--allow-staged`, or commit the changes to these files:
+[ERROR] the working directory of this package has uncommitted changes, and `cargo fix` can potentially perform destructive changes; if you'd like to suppress this error pass `--allow-dirty`, or commit the changes to these files:
 
   * src/lib.rs (dirty)
 
@@ -656,7 +656,7 @@ fn warns_about_staged_working_directory() {
     p.cargo("fix")
         .with_status(101)
         .with_stderr_data(str![[r#"
-[ERROR] the working directory of this package has uncommitted changes, and `cargo fix` can potentially perform destructive changes; if you'd like to suppress this error pass `--allow-dirty`, `--allow-staged`, or commit the changes to these files:
+[ERROR] the working directory of this package has uncommitted changes, and `cargo fix` can potentially perform destructive changes; if you'd like to suppress this error pass `--allow-dirty`, or commit the changes to these files:
 
   * src/lib.rs (staged)
 
@@ -677,7 +677,7 @@ fn errors_about_untracked_files() {
     p.cargo("fix")
         .with_status(101)
         .with_stderr_data(str![[r#"
-[ERROR] the working directory of this package has uncommitted changes, and `cargo fix` can potentially perform destructive changes; if you'd like to suppress this error pass `--allow-dirty`, `--allow-staged`, or commit the changes to these files:
+[ERROR] the working directory of this package has uncommitted changes, and `cargo fix` can potentially perform destructive changes; if you'd like to suppress this error pass `--allow-dirty`, or commit the changes to these files:
 
   * Cargo.toml (dirty)
   * src/ (dirty)