rebase: clarify --reschedule-failed-exec default
Documentation should mention the default behavior. It is better to explain the persistent nature of the --reschedule-failed-exec flag from the user standpoint, rather than from the implementation standpoint. Signed-off-by: Illia Bobyr <illia.bobyr@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Illia Bobyr committed
Jan 4, 2024 at 17:14 UTC
25aec063265f9efbe542f1a15e6f634b715d305d
1 file changed
+10
-7
Documentation/git-rebase.txt
+10
-7
@@ -620,13 +620,16 @@ See also INCOMPATIBLE OPTIONS below.
620
Automatically reschedule `exec` commands that failed. This only makes
621
sense in interactive mode (or when an `--exec` option was provided).
622
+
623
-Even though this option applies once a rebase is started, it's set for
624
-the whole rebase at the start based on either the
625
-`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1]
626
-or "CONFIGURATION" below) or whether this option is
627
-provided. Otherwise an explicit `--no-reschedule-failed-exec` at the
628
-start would be overridden by the presence of
629
-`rebase.rescheduleFailedExec=true` configuration.
623
+This option applies once a rebase is started. It is preserved for the whole
624
+rebase based on, in order, the command line option provided to the initial `git
625
+rebase`, the `rebase.rescheduleFailedExec` configuration (see
626
+linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false.
627
++
628
+Recording this option for the whole rebase is a convenience feature. Otherwise
629
+an explicit `--no-reschedule-failed-exec` at the start would be overridden by
630
+the presence of a `rebase.rescheduleFailedExec=true` configuration when `git
631
+rebase --continue` is invoked. Currently, you cannot pass
632
+`--[no-]reschedule-failed-exec` to `git rebase --continue`.
633
634
--update-refs::
635
--no-update-refs::