Documentation/remote-helpers: Rewrite description
[gitweb.git] / Documentation / git-merge-file.txt
index 149f1310519bb5b732fca0926f786f80a153f8da..f334d694e0160df91d197293e5b76cc0bfaac187 100644 (file)
@@ -9,23 +9,24 @@ git-merge-file - Run a three-way file merge
 SYNOPSIS
 --------
 [verse]
-'git-merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]]
-       [-p|--stdout] [-q|--quiet] <current-file> <base-file> <other-file>
+'git merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]]
+       [--ours|--theirs|--union] [-p|--stdout] [-q|--quiet] [--marker-size=<n>]
+       <current-file> <base-file> <other-file>
 
 
 DESCRIPTION
 -----------
-git-file-merge incorporates all changes that lead from the `<base-file>`
+'git merge-file' incorporates all changes that lead from the `<base-file>`
 to `<other-file>` into `<current-file>`. The result ordinarily goes into
-`<current-file>`. git-merge-file is useful for combining separate changes
+`<current-file>`. 'git merge-file' is useful for combining separate changes
 to an original. Suppose `<base-file>` is the original, and both
-`<current-file>` and `<other-file>` are modifications of `<base-file>`.
-Then git-merge-file combines both changes.
+`<current-file>` and `<other-file>` are modifications of `<base-file>`,
+then 'git merge-file' combines both changes.
 
 A conflict occurs if both `<current-file>` and `<other-file>` have changes
-in a common segment of lines. If a conflict is found, git-merge-file
-normally outputs a warning and brackets the conflict with <<<<<<< and
->>>>>>> lines. A typical conflict will look like this:
+in a common segment of lines. If a conflict is found, 'git merge-file'
+normally outputs a warning and brackets the conflict with lines containing
+<<<<<<< and >>>>>>> markers. A typical conflict will look like this:
 
        <<<<<<< A
        lines in file A
@@ -34,13 +35,16 @@ normally outputs a warning and brackets the conflict with <<<<<<< and
        >>>>>>> B
 
 If there are conflicts, the user should edit the result and delete one of
-the alternatives.
+the alternatives.  When `--ours`, `--theirs`, or `--union` option is in effect,
+however, these conflicts are resolved favouring lines from `<current-file>`,
+lines from `<other-file>`, or lines from both respectively.  The length of the
+conflict markers can be given with the `--marker-size` option.
 
 The exit value of this program is negative on error, and the number of
 conflicts otherwise. If the merge was clean, the exit value is 0.
 
-git-merge-file is designed to be a minimal clone of RCS merge, that is, it
-implements all of RCS merge's functionality which is needed by
+'git merge-file' is designed to be a minimal clone of RCS 'merge'; that is, it
+implements all of RCS 'merge''s functionality which is needed by
 linkgit:git[1].
 
 
@@ -51,7 +55,7 @@ OPTIONS
        This option may be given up to three times, and
        specifies labels to be used in place of the
        corresponding file names in conflict reports. That is,
-       `git-merge-file -L x -L y -L z a b c` generates output that
+       `git merge-file -L x -L y -L z a b c` generates output that
        looks like it came from files x, y and z instead of
        from files a, b and c.
 
@@ -60,7 +64,13 @@ OPTIONS
        `<current-file>`.
 
 -q::
-       Quiet;  do  not  warn about conflicts.
+       Quiet; do not warn about conflicts.
+
+--ours::
+--theirs::
+--union::
+       Instead of leaving conflicts in the file, resolve conflicts
+       favouring our (or their or both) side of the lines.
 
 
 EXAMPLES
@@ -85,7 +95,7 @@ Written by Johannes Schindelin <johannes.schindelin@gmx.de>
 Documentation
 --------------
 Documentation by Johannes Schindelin and the git-list <git@vger.kernel.org>,
-with parts copied from the original documentation of RCS merge.
+with parts copied from the original documentation of RCS 'merge'.
 
 GIT
 ---