Skip to content

Commit

Permalink
user-manual: Document that "git merge" doesn't like uncommited changes.
Browse files Browse the repository at this point in the history
We explain the user why uncommited changes can be problematic with merge,
and point to "commit" and "stash" for the solution. While talking about
commited Vs uncommited changes, we also make it clear that the result of
a merge is normally commited.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Matthieu Moy authored and Junio C Hamano committed Nov 23, 2009
1 parent 4c371f9 commit e63ec00
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions Documentation/user-manual.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1183,7 +1183,23 @@ $ git merge branchname
-------------------------------------------------

merges the development in the branch "branchname" into the current
branch. If there are conflicts--for example, if the same file is
branch.

A merge is made by combining the changes made in "branchname" and the
changes made up to the latest commit in your current branch since
their histories forked. The work tree is overwritten by the result of
the merge when this combining is done cleanly, or overwritten by a
half-merged results when this combining results in conflicts.
Therefore, if you have uncommitted changes touching the same files as
the ones impacted by the merge, Git will refuse to proceed. Most of
the time, you will want to commit your changes before you can merge,
and if you don't, then linkgit:git-stash[1] can take these changes
away while you're doing the merge, and reapply them afterwards.

If the changes are independant enough, Git will automatically complete
the merge and commit the result (or reuse an existing commit in case
of <<fast-forwards,fast-forward>>, see below). On the other hand,
if there are conflicts--for example, if the same file is
modified in two different ways in the remote branch and the local
branch--then you are warned; the output may look something like this:

Expand Down Expand Up @@ -1679,7 +1695,7 @@ Sharing development with others
Getting updates with git pull
-----------------------------

After you clone a repository and make a few changes of your own, you
After you clone a repository and commit a few changes of your own, you
may wish to check the original repository for updates and merge them
into your own work.

Expand Down

0 comments on commit e63ec00

Please sign in to comment.