git-svn: add --prefix= option to multi-init

[git.git] / Documentation / git-merge.txt
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt

index c1174041ec61c3e6012d6a55d48cfbac562a35b5..0f79665ea6e6bf1ffd4ff67f7aee2fcbddec0555 100644 (file)
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -8,12 +8,13 @@ git-merge - Grand Unified Merge Driver
  
  SYNOPSIS
  --------
-'git-merge' [-n] [--no-commit] [-s <strategy>]... <msg> <head> <remote> <remote>...
-
+[verse]
+'git-merge' [-n] [--no-commit] [--squash] [-s <strategy>]...
+       -m=<msg> <remote> <remote>...
  
  DESCRIPTION
  -----------
-This is the top-level user interface to the merge machinery
+This is the top-level interface to the merge machinery
  which drives multiple merge strategy scripts.
  
  
@@ -27,16 +28,22 @@ include::merge-options.txt[]
         to give a good default for automated `git-merge` invocations.
  
  <head>::
-       our branch head commit.
+       Our branch head commit.  This has to be `HEAD`, so new
+       syntax does not require it
  
  <remote>::
-       other branch head merged into our branch.  You need at
+       Other branch head merged into our branch.  You need at
         least one <remote>.  Specifying more than one <remote>
         obviously means you are trying an Octopus.
  
  include::merge-strategies.txt[]
  
  
+If you tried a merge which resulted in a complex conflicts and
+would want to start over, you can recover with
+gitlink:git-reset[1].
+
+
  HOW MERGE WORKS
  ---------------
  
@@ -78,7 +85,7 @@ your local modifications interfere with the merge, again, it
  stops before touching anything.
  
  So in the above two "failed merge" case, you do not have to
-worry about lossage of data --- you simply were not ready to do
+worry about loss of data --- you simply were not ready to do
  a merge, so no merge happened at all.  You may want to finish
  whatever you were in the middle of doing, and retry the same
  pull after you are done and ready.
@@ -108,10 +115,12 @@ When there are conflicts, these things happen:
  2. Cleanly merged paths are updated both in the index file and
     in your working tree.
  
-3. For conflicting paths, the index file records the version
-   from `HEAD`. The working tree files have the result of
-   "merge" program; i.e. 3-way merge result with familiar
-   conflict markers `<<< === >>>`.
+3. For conflicting paths, the index file records up to three
+   versions; stage1 stores the version from the common ancestor,
+   stage2 from `HEAD`, and stage3 from the remote branch (you
+   can inspect the stages with `git-ls-files -u`).  The working
+   tree files have the result of "merge" program; i.e. 3-way
+   merge result with familiar conflict markers `<<< === >>>`.
  
  4. No other changes are done.  In particular, the local
     modifications you had before you started merge will stay the