rebase: clarify --reschedule-failed-exec default
PATCH 1/1 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.
--- Documentation/git-rebase.txt | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-)
git-rebase.txt +10 -7
@@ -626,13 +626,16 @@ See also INCOMPATIBLE OPTIONS below. Automatically reschedule `exec` commands that failed. This only makes sense in interactive mode (or when an `--exec` option was provided). + -Even though this option applies once a rebase is started, it's set for -the whole rebase at the start based on either the -`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1] -or "CONFIGURATION" below) or whether this option is -provided. Otherwise an explicit `--no-reschedule-failed-exec` at the -start would be overridden by the presence of -`rebase.rescheduleFailedExec=true` configuration. +This option applies once a rebase is started. It is preserved for the whole +rebase based on, in order, the command line option provided to the initial `git +rebase`, the `rebase.rescheduleFailedExec` configuration (see +linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false. ++ +Recording this option for the whole rebase is a convenience feature. Otherwise +an explicit `--no-reschedule-failed-exec` at the start would be overridden by +the presence of a `rebase.rescheduleFailedExec=true` configuration when `git +rebase --continue` is invoked. Currently, you can not, pass +`--[no-]reschedule-failed-exec` to `git rebase --continue`. --update-refs:: --no-update-refs::
Signature · 1 line
2.40.1
Quoted 5 lines · Illia Bobyr
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.
The first paragraph looks good, and I think your wording is an improvement over what's already there (though of course this is subjective, and YMMV).
git-rebase.txt See also INCOMPATIBLE OPTIONS below. · line 638
Quoted 5 lines
git-rebase.txt +5
-0+Recording this option for the whole rebase is a convenience feature. Otherwise +an explicit `--no-reschedule-failed-exec` at the start would be overridden by +the presence of a `rebase.rescheduleFailedExec=true` configuration when `git +rebase --continue` is invoked. Currently, you can not, pass +`--[no-]reschedule-failed-exec` to `git rebase --continue`.
The last sentence was a bit confusing to me. I assume you meant
Currently, you cannot pass --[no-]reschedule-failed-exec [...]
without the comma between "pass" and "--[no]reschedule-failed-exect", and replacing "can not" with "cannot".
Thanks,
Taylor
Illia Bobyr
AppliedPATCH v2 1/1 rebase: clarify --reschedule-failed-exec default
Applied.
Thank you for reviewing!
PATCH v2 1/1 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.
--- Documentation/git-rebase.txt | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-)
git-rebase.txt +10 -7
@@ -626,13 +626,16 @@ See also INCOMPATIBLE OPTIONS below. Automatically reschedule `exec` commands that failed. This only makes sense in interactive mode (or when an `--exec` option was provided). + -Even though this option applies once a rebase is started, it's set for -the whole rebase at the start based on either the -`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1] -or "CONFIGURATION" below) or whether this option is -provided. Otherwise an explicit `--no-reschedule-failed-exec` at the -start would be overridden by the presence of -`rebase.rescheduleFailedExec=true` configuration. +This option applies once a rebase is started. It is preserved for the whole +rebase based on, in order, the command line option provided to the initial `git +rebase`, the `rebase.rescheduleFailedExec` configuration (see +linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false. ++ +Recording this option for the whole rebase is a convenience feature. Otherwise +an explicit `--no-reschedule-failed-exec` at the start would be overridden by +the presence of a `rebase.rescheduleFailedExec=true` configuration when `git +rebase --continue` is invoked. Currently, you can not, pass +`--[no-]reschedule-failed-exec` to `git rebase --continue`. --update-refs:: --no-update-refs::
Signature · 1 line
2.40.1
Illia Bobyr
AppliedPATCH v3 1/1 rebase: clarify --reschedule-failed-exec default
In reply to Taylor BlauSorry, I did not actually include the change in v2. Still learning how to use git send-email.
Quoted 10 lines · Taylor Blau
[...]
git-rebase.txt See also INCOMPATIBLE OPTIONS below. · line 638
Quoted 5 lines
git-rebase.txt +5
-0+Recording this option for the whole rebase is a convenience feature. Otherwise +an explicit `--no-reschedule-failed-exec` at the start would be overridden by +the presence of a `rebase.rescheduleFailedExec=true` configuration when `git +rebase --continue` is invoked. Currently, you can not, pass +`--[no-]reschedule-failed-exec` to `git rebase --continue`.The last sentence was a bit confusing to me. I assume you meant
Quoted 4 lines
Currently, you cannot pass
--[no-]reschedule-failed-exec[...]without the comma between "pass" and "
--[no]reschedule-failed-exect", and replacing "can not" with "cannot".
Applied.
Thank you for reviewing!
PATCH v3 1/1 rebase: clarify --reschedule-failed-exec default
In reply to Taylor BlauDocumentation 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.
--- Documentation/git-rebase.txt | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-)
git-rebase.txt +10 -7
@@ -626,13 +626,16 @@ See also INCOMPATIBLE OPTIONS below. Automatically reschedule `exec` commands that failed. This only makes sense in interactive mode (or when an `--exec` option was provided). + -Even though this option applies once a rebase is started, it's set for -the whole rebase at the start based on either the -`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1] -or "CONFIGURATION" below) or whether this option is -provided. Otherwise an explicit `--no-reschedule-failed-exec` at the -start would be overridden by the presence of -`rebase.rescheduleFailedExec=true` configuration. +This option applies once a rebase is started. It is preserved for the whole +rebase based on, in order, the command line option provided to the initial `git +rebase`, the `rebase.rescheduleFailedExec` configuration (see +linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false. ++ +Recording this option for the whole rebase is a convenience feature. Otherwise +an explicit `--no-reschedule-failed-exec` at the start would be overridden by +the presence of a `rebase.rescheduleFailedExec=true` configuration when `git +rebase --continue` is invoked. Currently, you cannot pass +`--[no-]reschedule-failed-exec` to `git rebase --continue`. --update-refs:: --no-update-refs::
Signature · 1 line
2.40.1
Quoted 3 lines · Illia Bobyr
--- Documentation/git-rebase.txt | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-)
LGTM.
Thanks,
Taylor