aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorPetr Baudis <pasky@suse.cz>2005-11-01 21:45:55 +0100
committerJunio C Hamano <junkio@cox.net>2005-11-01 14:45:49 -0800
commit3c64314c4b1f90488391a0ffea2a4ed04c8f6b79 (patch)
tree84b5ed3295ea3f148194061c8475e348d3793769 /Documentation
parente3a39000e295e4bd6faff97decc31e6cb4520bb1 (diff)
downloadgit-3c64314c4b1f90488391a0ffea2a4ed04c8f6b79.tar.gz
git-3c64314c4b1f90488391a0ffea2a4ed04c8f6b79.tar.xz
Documentation for git-fmt-merge-msg
Simple description. It appears to be mostly internal command, but hey, it is (it seems) the only undocumented one, so let's fix it up... Also add a note about it to git-merge documentation. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-fmt-merge-msg.txt39
-rw-r--r--Documentation/git-merge.txt10
2 files changed, 49 insertions, 0 deletions
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
new file mode 100644
index 000000000..a70eb3994
--- /dev/null
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -0,0 +1,39 @@
+git-fmt-merge-msg(1)
+====================
+
+NAME
+----
+git-fmt-merge-msg - Produce a merge commit message
+
+
+SYNOPSIS
+--------
+'git-fmt-merge-msg' <$GIT_DIR/FETCH_HEAD
+
+DESCRIPTION
+-----------
+Takes the list of merged objects on stdin and produces a suitable
+commit message to be used for the merge commit, usually to be
+passed as the '<merge-message>' argument of `git-merge`.
+
+This script is intended mostly for internal use by scripts
+automatically invoking `git-merge`.
+
+
+SEE ALSO
+--------
+gitlink:git-merge[1]
+
+
+Author
+------
+Written by Junio C Hamano <junkio@cox.net>
+
+Documentation
+--------------
+Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the gitlink:git[7] suite
+
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index a007a8b15..8c9c4d87e 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -28,6 +28,11 @@ OPTIONS
there is no `-s` option, built-in list of strategies is
used instead.
+<msg>::
+ The commit message to be used for the merge commit (in case
+ it is created). The `git-fmt-merge-msg` script can be used
+ to give a good default for automated `git-merge` invocations.
+
<head>::
our branch head commit.
@@ -37,6 +42,11 @@ OPTIONS
obviously means you are trying an Octopus.
+SEE ALSO
+--------
+gitlink:git-fmt-merge-msg[1]
+
+
Author
------
Written by Junio C Hamano <junkio@cox.net>