diff mbox series

doc: clarify rerere-autoupdate

Message ID 20220803205915.1550797-1-gitster@pobox.com (mailing list archive)
State Accepted
Commit cb54fc93e4627d9496fff1c4ba18b1705802d069
Headers show
Series doc: clarify rerere-autoupdate | expand

Commit Message

Junio C Hamano Aug. 3, 2022, 8:59 p.m. UTC 
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>
---
 Documentation/rerere-options.txt | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
diff mbox series

Patch

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`.