login
Header Space

 
 

[PATCH] Document git-merge-file

Score:
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
To: Junio C Hamano <junkio@...>
Cc: <git@...>
Date: Saturday, December 16, 2006 - 7:22 am

Most of this is derived from the documentation of RCS merge.

Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
---

	On Sat, 16 Dec 2006, Junio C Hamano wrote:

	> >>  - 'git-merge-file' needs to be documented and linked from
	> >>    git.txt.

 Documentation/git-merge-file.txt |   92 ++++++++++++++++++++++++++++++++++++++
 Documentation/git.txt            |    3 +
 2 files changed, 95 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt
new file mode 100644
index 0000000..0b41d66
--- /dev/null
+++ b/Documentation/git-merge-file.txt
@@ -0,0 +1,92 @@
+git-merge-file(1)
+============
+
+NAME
+----
+git-merge-file - threeway 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>
+
+
+DESCRIPTION
+-----------
+git-file-merge 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
+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.
+
+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:
+
+	<<<<<<< A
+	lines in file A
+	=======
+	lines in file B
+	>>>>>>> B
+
+If there are conflicts, the user should edit the result and delete one of
+the alternatives.
+
+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
+gitlink:git[1].
+
+
+OPTIONS
+-------
+
+-L <label>::
+	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
+	looks like it came from files x, y and z instead of
+	from files a, b and c.
+
+-p::
+	Send results to standard output instead of overwriting
+	`<current-file>`.
+
+-q::
+	Quiet;  do  not  warn about conflicts.
+
+
+EXAMPLES
+--------
+
+git merge-file README.my README README.upstream::
+
+	combines the changes of README.my and README.upstream since README,
+	tries to merge them and writes the result into README.my.
+
+git merge-file -L a -L b -L c tmp/a123 tmp/b234 tmp/c345::
+
+	merges tmp/a123 and tmp/c345 with the base tmp/b234, but uses labels
+	`a` and `c` instead of `tmp/a123` and `tmp/c345`.
+
+
+Author
+------
+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.
+
+GIT
+---
+Part of the gitlink:git[7] suite
diff --git a/Documentation/git.txt b/Documentation/git.txt
index b9b1e63..b9fc9ae 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -359,6 +359,9 @@ gitlink:git-init-db[1]::
 	Creates an empty git object database, or reinitialize an
 	existing one.
 
+gitlink:git-merge-file[1]::
+	Runs a threeway merge.
+
 gitlink:git-merge-index[1]::
 	Runs a merge for files needing merging.
 
-- 
1.4.4.2.g5dc03

-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

Messages in current thread:
What's in git.git (stable), Junio C Hamano, (Wed Dec 13, 5:35 pm)
Re: What's in git.git (stable), Junio C Hamano, (Sat Dec 16, 5:58 am)
[PATCH] Document git-merge-file, Johannes Schindelin, (Sat Dec 16, 7:22 am)
Re: What's in git.git (stable), Andy Parkins, (Wed Dec 13, 6:37 pm)
Re: What's in git.git (stable), Shawn Pearce, (Thu Dec 14, 7:03 pm)
Re: What's in git.git (stable), Johannes Schindelin, (Wed Dec 13, 8:22 pm)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 6:21 am)
Re: What's in git.git (stable), Nicolas Pitre, (Thu Dec 14, 1:23 pm)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 5:02 pm)
Re: What's in git.git (stable), Johannes Schindelin, (Thu Dec 14, 6:51 am)
Re: What's in git.git (stable) , Horst H. von Brand, (Thu Dec 14, 8:15 pm)
Re: What's in git.git (stable) , Johannes Schindelin, (Thu Dec 14, 8:23 pm)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 7:23 am)
Re: What's in git.git (stable), Johannes Schindelin, (Thu Dec 14, 7:27 am)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 8:00 am)
Re: What's in git.git (stable), Shawn Pearce, (Thu Dec 14, 8:10 am)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 9:20 am)
Re: What's in git.git (stable), Junio C Hamano, (Wed Dec 13, 7:31 pm)
Re: What's in git.git (stable) , Horst H. von Brand, (Thu Dec 14, 7:52 pm)
Re: What's in git.git (stable), Johannes Schindelin, (Wed Dec 13, 8:16 pm)
Re: What's in git.git (stable), Nicolas Pitre, (Wed Dec 13, 11:32 pm)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 2:29 am)
git-show, was Re: What's in git.git (stable), Johannes Schindelin, (Thu Dec 14, 3:59 am)
Re: git-show, was Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 4:28 am)
Re: git-show, was Re: What's in git.git (stable), Johannes Schindelin, (Thu Dec 14, 6:25 am)
Re: What's in git.git (stable), Andreas Ericsson, (Thu Dec 14, 4:28 am)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 5:59 am)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 5:22 pm)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 6:55 pm)
Re: What's in git.git (stable), Johannes Schindelin, (Thu Dec 14, 7:53 pm)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 7:46 pm)
Re: What's in git.git (stable), Andy Parkins, (Fri Dec 15, 4:58 am)
RE: What's in git.git (stable), Raimund Bauer, (Fri Dec 15, 5:55 am)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 6:21 am)
Re: What's in git.git (stable), Nicolas Pitre, (Fri Dec 15, 12:07 am)
Re: [PATCH] make commit message a little more consistent and..., Andreas Ericsson, (Fri Dec 15, 11:32 am)
Re: [PATCH] make commit message a little more consistent and..., Andreas Ericsson, (Fri Dec 15, 11:50 am)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 7:36 am)
Re: What's in git.git (stable), Shawn Pearce, (Thu Dec 14, 7:45 am)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 5:58 pm)
Re: What's in git.git (stable), Andy Parkins, (Thu Dec 14, 6:50 pm)
Re: What's in git.git (stable), Nicolas Pitre, (Thu Dec 14, 1:47 pm)
Re: What's in git.git (stable), Carl Worth, (Thu Dec 14, 7:58 am)
Re: What's in git.git (stable), Shawn Pearce, (Thu Dec 14, 8:05 am)
Re: What's in git.git (stable), Nicolas Pitre, (Thu Dec 14, 2:06 pm)
[PATCH] Enable reflogs by default in all repositories., Shawn O. Pearce, (Thu Dec 14, 3:58 pm)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 3:52 pm)
Re: What's in git.git (stable), Nicolas Pitre, (Thu Dec 14, 4:17 pm)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 4:50 pm)
Re: What's in git.git (stable), Shawn Pearce, (Thu Dec 14, 4:02 pm)
Re: What's in git.git (stable), Andreas Ericsson, (Thu Dec 14, 5:55 pm)
Re: What's in git.git (stable), Junio C Hamano, (Thu Dec 14, 4:35 pm)
Re: What's in git.git (stable), Shawn Pearce, (Thu Dec 14, 6:44 pm)
Re: [PATCH] Enable reflogs by default in any repository with..., Johannes Schindelin, (Thu Dec 14, 8:13 pm)
Re: What's in git.git (stable), Nicolas Pitre, (Thu Dec 14, 4:22 pm)
reflog by default?, was Re: What's in git.git (stable), Johannes Schindelin, (Thu Dec 14, 10:03 am)
speck-geostationary