aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/rerere-options.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-08-03 13:49:59 -0700
committerJunio C Hamano <gitster@pobox.com>2022-08-03 13:57:25 -0700
commitcb54fc93e4627d9496fff1c4ba18b1705802d069 (patch)
treefc9c8216d7ab366153fb723301425e174add3d1b /Documentation/rerere-options.txt
parent0dbc715ae0ccf0991d032173d86890a90bf94814 (diff)
downloadgit-cb54fc93e4627d9496fff1c4ba18b1705802d069.tar.gz
doc: clarify rerere-autoupdate
The "--[no-]rerere-autoupdate" option controls what happens _after_ the rerere mechanism kicks in to reuse recorded resolutions and does not prevent from the rerere mechanism to trigger in the first place. It is unclear in the current text if "--no-rerere-autoupdate" stops the auto-resolution. Rewrite the sentence to clarify. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/rerere-options.txt')
-rw-r--r--Documentation/rerere-options.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/rerere-options.txt b/Documentation/rerere-options.txt
index 8f4849e272..c3321ddea2 100644
--- a/Documentation/rerere-options.txt
+++ b/Documentation/rerere-options.txt
@@ -1,4 +1,9 @@
--rerere-autoupdate::
--no-rerere-autoupdate::
- Allow the rerere mechanism to update the index with the
- result of auto-conflict resolution if possible.
+ 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`.