Merge branch 'ap/trackinfo'
[git/git.git] / Documentation / git-fmt-merge-msg.txt
CommitLineData
3c64314c
PB
1git-fmt-merge-msg(1)
2====================
3
4NAME
5----
6git-fmt-merge-msg - Produce a merge commit message
7
8
9SYNOPSIS
10--------
e448ff87 11[verse]
483bc4f0
JN
12'git fmt-merge-msg' [--log | --no-log] <$GIT_DIR/FETCH_HEAD
13'git fmt-merge-msg' [--log | --no-log] -F <file>
3c64314c
PB
14
15DESCRIPTION
16-----------
17Takes the list of merged objects on stdin and produces a suitable
18commit message to be used for the merge commit, usually to be
ba020ef5 19passed as the '<merge-message>' argument of 'git-merge'.
3c64314c
PB
20
21This script is intended mostly for internal use by scripts
ba020ef5 22automatically invoking 'git-merge'.
3c64314c 23
2bc060cc
AR
24OPTIONS
25-------
26
6cd9cfef 27--log::
2bc060cc
AR
28 In addition to branch names, populate the log message with
29 one-line descriptions from the actual commits that are being
30 merged.
31
6cd9cfef 32--no-log::
2bc060cc
AR
33 Do not list one-line descriptions from the actual commits being
34 merged.
35
3240240f
SB
36--summary::
37--no-summary::
6cd9cfef
SG
38 Synonyms to --log and --no-log; these are deprecated and will be
39 removed in the future.
40
3240240f
SB
41-F <file>::
42--file <file>::
2bc060cc
AR
43 Take the list of merged objects from <file> instead of
44 stdin.
45
46CONFIGURATION
47-------------
48
6cd9cfef 49merge.log::
2bc060cc
AR
50 Whether to include summaries of merged commits in newly
51 merge commit messages. False by default.
3c64314c 52
6cd9cfef
SG
53merge.summary::
54 Synonym to `merge.log`; this is deprecated and will be removed in
55 the future.
56
3c64314c
PB
57SEE ALSO
58--------
5162e697 59linkgit:git-merge[1]
3c64314c
PB
60
61
62Author
63------
64Written by Junio C Hamano <junkio@cox.net>
65
66Documentation
67--------------
68Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
69
70GIT
71---
9e1f0a85 72Part of the linkgit:git[1] suite