Document merge.branchdesc configuration variable
[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]
96e9420c
RR
12'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] <$GIT_DIR/FETCH_HEAD
13'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --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
0b444cdb 19passed as the '<merge-message>' argument of 'git merge'.
3c64314c 20
0f8a02c6
JN
21This command is intended mostly for internal use by scripts
22automatically invoking 'git merge'.
3c64314c 23
2bc060cc
AR
24OPTIONS
25-------
26
96e9420c 27--log[=<n>]::
2bc060cc
AR
28 In addition to branch names, populate the log message with
29 one-line descriptions from the actual commits that are being
96e9420c
RR
30 merged. At most <n> commits from each merge parent will be
31 used (20 if <n> is omitted). This overrides the `merge.log`
32 configuration variable.
2bc060cc 33
6cd9cfef 34--no-log::
2bc060cc
AR
35 Do not list one-line descriptions from the actual commits being
36 merged.
37
3240240f
SB
38--summary::
39--no-summary::
6cd9cfef
SG
40 Synonyms to --log and --no-log; these are deprecated and will be
41 removed in the future.
42
2102440c
JN
43-m <message>::
44--message <message>::
45 Use <message> instead of the branch names for the first line
46 of the log message. For use with `--log`.
47
3240240f
SB
48-F <file>::
49--file <file>::
2bc060cc
AR
50 Take the list of merged objects from <file> instead of
51 stdin.
52
53CONFIGURATION
54-------------
55
8c80ff36
JH
56merge.branchdesc::
57 In addition to branch names, populate the log message with
58 the branch description text associated with them. Defaults
59 to false.
60
6cd9cfef 61merge.log::
bda3b8ff
RR
62 In addition to branch names, populate the log message with at
63 most the specified number of one-line descriptions from the
64 actual commits that are being merged. Defaults to false, and
469bfc96 65 true is a synonym for 20.
3c64314c 66
6cd9cfef
SG
67merge.summary::
68 Synonym to `merge.log`; this is deprecated and will be removed in
69 the future.
70
3c64314c
PB
71SEE ALSO
72--------
5162e697 73linkgit:git-merge[1]
3c64314c 74
3c64314c
PB
75GIT
76---
9e1f0a85 77Part of the linkgit:git[1] suite