Start preparing Release Notes for 1.5.0.3
[gitweb.git] / Documentation / git-merge-index.txt
index 5caee90adc43d2f59893f3e59fda23b5a05462a9..b8ee1ff2b0681ea9fbc83618b1d09d95f3a902ff 100644 (file)
@@ -1,30 +1,29 @@
 git-merge-index(1)
 ==================
-v0.1, May 2005
 
 NAME
 ----
-git-merge-index - Runs a merge for files needing merging
+git-merge-index - Run a merge for files needing merging
 
 
 SYNOPSIS
 --------
-'git-merge-index' [-o] [-q] <merge-program> (-a | -- | <file>\*)
+'git-merge-index' [-o] [-q] <merge-program> (-a | \-- | <file>\*)
 
 DESCRIPTION
 -----------
-This looks up the <file>(s) in the cache and, if there are any merge
+This looks up the <file>(s) in the index and, if there are any merge
 entries, passes the SHA1 hash for those files as arguments 1, 2, 3 (empty
 argument if no file), and <file> as argument 4.  File modes for the three
 files are passed as arguments 5, 6 and 7.
 
 OPTIONS
 -------
---::
-       Interpret all following arguments as filenames.
+\--::
+       Do not interpret any more arguments as options.
 
 -a::
-       Run merge against all files in the cache that need merging.
+       Run merge against all files in the index that need merging.
 
 -o::
        Instead of stopping at the first failed merge, do all of them
@@ -41,8 +40,8 @@ If "git-merge-index" is called with multiple <file>s (or -a) then it
 processes them in turn only stopping if merge returns a non-zero exit
 code.
 
-Typically this is run with the a script calling the merge command from
-the RCS package.
+Typically this is run with the a script calling git's imitation of
+the merge command from the RCS package.
 
 A sample script called "git-merge-one-file" is included in the
 distribution.
@@ -70,7 +69,7 @@ or
   fatal: merge program failed
 
 where the latter example shows how "git-merge-index" will stop trying to
-merge once anything has returned an error (ie "cat" returned an error
+merge once anything has returned an error (i.e., "cat" returned an error
 for the AA file, because it didn't exist in the original, and thus
 "git-merge-index" didn't even try to merge the MM thing).