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>
Petr Baudis committed
Nov 1, 2005 at 21:45 UTC
3c64314c4b1f90488391a0ffea2a4ed04c8f6b79
2 files changed
+49
Documentation/git-fmt-merge-msg.txt
new
+39
@@ -0,0 +1,39 @@
1
+git-fmt-merge-msg(1)
2
+====================
3
+
4
+NAME
5
+----
6
+git-fmt-merge-msg - Produce a merge commit message
7
+
8
+
9
+SYNOPSIS
10
+--------
11
+'git-fmt-merge-msg' <$GIT_DIR/FETCH_HEAD
12
+
13
+DESCRIPTION
14
+-----------
15
+Takes the list of merged objects on stdin and produces a suitable
16
+commit message to be used for the merge commit, usually to be
17
+passed as the '<merge-message>' argument of `git-merge`.
18
+
19
+This script is intended mostly for internal use by scripts
20
+automatically invoking `git-merge`.
21
+
22
+
23
+SEE ALSO
24
+--------
25
+gitlink:git-merge[1]
26
+
27
+
28
+Author
29
+------
30
+Written by Junio C Hamano <junkio@cox.net>
31
+
32
+Documentation
33
+--------------
34
+Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
35
+
36
+GIT
37
+---
38
+Part of the gitlink:git[7] suite
39
+
Documentation/git-merge.txt
+10
@@ -28,6 +28,11 @@ OPTIONS
28
there is no `-s` option, built-in list of strategies is
29
used instead.
30
31
+<msg>::
32
+ The commit message to be used for the merge commit (in case
33
+ it is created). The `git-fmt-merge-msg` script can be used
34
+ to give a good default for automated `git-merge` invocations.
35
+
36
<head>::
37
our branch head commit.
38
@@ -37,6 +42,11 @@ OPTIONS
42
obviously means you are trying an Octopus.
43
44
45
+SEE ALSO
46
+--------
47
+gitlink:git-fmt-merge-msg[1]
48
+
49
+
50
Author
51
------
52
Written by Junio C Hamano <junkio@cox.net>