aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-08-14 23:19:27 -0700
committerJunio C Hamano <gitster@pobox.com>2022-08-14 23:19:27 -0700
commit3adacc2817bf4644928b9430c7c6ed1ca2ef2655 (patch)
tree3f9693a0c1b8dc22664e5858a06e422a38d927eb
parentd86ac14dd7258a187fb19ad3d8e11f840350a01f (diff)
parentcb54fc93e4627d9496fff1c4ba18b1705802d069 (diff)
downloadgit-3adacc2817bf4644928b9430c7c6ed1ca2ef2655.tar.gz
Merge branch 'jc/rerere-autoupdate-doc'
Update documentation on the "--[no-]rerere-autoupdate" option. * jc/rerere-autoupdate-doc: doc: clarify rerere-autoupdate doc: consolidate --rerere-autoupdate description
-rw-r--r--Documentation/git-am.txt5
-rw-r--r--Documentation/git-cherry-pick.txt5
-rw-r--r--Documentation/git-merge.txt5
-rw-r--r--Documentation/git-rebase.txt5
-rw-r--r--Documentation/git-revert.txt5
-rw-r--r--Documentation/rerere-options.txt9
6 files changed, 14 insertions, 20 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 09107fb106..320da6c4f7 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -112,10 +112,7 @@ default. You can use `--no-utf8` to override this.
am.threeWay configuration variable. For more information,
see am.threeWay in linkgit:git-config[1].
---rerere-autoupdate::
---no-rerere-autoupdate::
- Allow the rerere mechanism to update the index with the
- result of auto-conflict resolution if possible.
+include::rerere-options.txt[]
--ignore-space-change::
--ignore-whitespace::
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 78dcc9171f..1e8ac9df60 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -156,10 +156,7 @@ effect to your index in a row.
Pass the merge strategy-specific option through to the
merge strategy. See linkgit:git-merge[1] for details.
---rerere-autoupdate::
---no-rerere-autoupdate::
- Allow the rerere mechanism to update the index with the
- result of auto-conflict resolution if possible.
+include::rerere-options.txt[]
SEQUENCER SUBCOMMANDS
---------------------
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 3125473cc1..fee1dc2df2 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -90,10 +90,7 @@ invocations. The automated message can include the branch description.
If `--log` is specified, a shortlog of the commits being merged
will be appended to the specified message.
---rerere-autoupdate::
---no-rerere-autoupdate::
- Allow the rerere mechanism to update the index with the
- result of auto-conflict resolution if possible.
+include::rerere-options.txt[]
--overwrite-ignore::
--no-overwrite-ignore::
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 080658c871..1877942180 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -376,10 +376,7 @@ See also INCOMPATIBLE OPTIONS below.
+
See also INCOMPATIBLE OPTIONS below.
---rerere-autoupdate::
---no-rerere-autoupdate::
- Allow the rerere mechanism to update the index with the
- result of auto-conflict resolution if possible.
+include::rerere-options.txt[]
-S[<keyid>]::
--gpg-sign[=<keyid>]::
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 8463fe9cf7..0105a54c1a 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -112,10 +112,7 @@ effect to your index in a row.
Pass the merge strategy-specific option through to the
merge strategy. See linkgit:git-merge[1] for details.
---rerere-autoupdate::
---no-rerere-autoupdate::
- Allow the rerere mechanism to update the index with the
- result of auto-conflict resolution if possible.
+include::rerere-options.txt[]
--reference::
Instead of starting the body of the log message with "This
diff --git a/Documentation/rerere-options.txt b/Documentation/rerere-options.txt
new file mode 100644
index 0000000000..c3321ddea2
--- /dev/null
+++ b/Documentation/rerere-options.txt
@@ -0,0 +1,9 @@
+--rerere-autoupdate::
+--no-rerere-autoupdate::
+ After the rerere mechanism reuses a recorded resolution on
+ the current conflict to update the files in the working
+ tree, allow it to also update the index with the result of
+ resolution. `--no-rerere-autoupdate` is a good way to
+ double-check what `rerere` did and catch potential
+ mismerges, before committing the result to the index with a
+ separate `git add`.