[PATCH] Documentation/git-merge.txt: weaken warning about uncommited changes

Subsystems: documentation, the rest

DORMANTno replies

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

[PATCH] Documentation/git-merge.txt: weaken warning about uncommited changes

From: Matthieu Moy <hidden>
Date: 2016-06-15 22:57:48

Commit 35d2fffd introduced 'git merge --abort' as a synonym to 'git reset
--merge', and added some failing tests in t7611-merge-abort.sh (search
'###' in this file) showing that 'git merge --abort' could not always
recover the pre-merge state.

Still, in many cases, 'git merge --abort' just works, and it is usually
considered that the ability to start a merge with uncommited changes is
an important property of Git.

Weaken the warning by discouraging only merge with /non-trivial/
uncommited changes.

Signed-off-by: Matthieu Moy <redacted>
---
This is a followup to an old discussion:

http://thread.gmane.org/gmane.comp.version-control.git/221069

I don't think documenting all the failure cases in the doc would be a
good idea, so I've left the "in some cases" part.

 Documentation/git-merge.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 67ca99c..8c7f2f6 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -56,8 +56,8 @@ especially if those changes were further modified after the merge
 was started), 'git merge --abort' will in some cases be unable to
 reconstruct the original (pre-merge) changes. Therefore:
 
-*Warning*: Running 'git merge' with uncommitted changes is
-discouraged: while possible, it leaves you in a state that is hard to
+*Warning*: Running 'git merge' with non-trivial uncommitted changes is
+discouraged: while possible, it may leave you in a state that is hard to
 back out of in the case of a conflict.
 
 
-- 
1.8.3.1.495.g13f33cf.dirty

Re: [PATCH] Documentation/git-merge.txt: weaken warning about uncommited changes

From: Ramkumar Ramachandra <hidden>
Date: 2016-06-15 22:57:48

Matthieu Moy wrote:
Weaken the warning by discouraging only merge with /non-trivial/
uncommited changes.

I don't think documenting all the failure cases in the doc would be a
good idea, so I've left the "in some cases" part.
It's already documented in the pre-merge checks section, as Jonathan
pointed out [1].  We should update the documentation to point to it: I
do not think "non-trivial" is much of an improvement.

[1]: http://thread.gmane.org/gmane.comp.version-control.git/221069/focus=221366
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help