Sixth batch
[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]
33e8fc87 12'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log]
96e9420c 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
0460ed2c 38--[no-]summary::
6cd9cfef
SG
39 Synonyms to --log and --no-log; these are deprecated and will be
40 removed in the future.
41
2102440c
JN
42-m <message>::
43--message <message>::
44 Use <message> instead of the branch names for the first line
45 of the log message. For use with `--log`.
46
3240240f
SB
47-F <file>::
48--file <file>::
2bc060cc
AR
49 Take the list of merged objects from <file> instead of
50 stdin.
51
52CONFIGURATION
53-------------
5a06936b 54include::config/fmt-merge-msg.txt[]
3c64314c 55
6cd9cfef
SG
56merge.summary::
57 Synonym to `merge.log`; this is deprecated and will be removed in
58 the future.
59
76a8788c
NTND
60EXAMPLES
61--------
33e8fc87 62
4259d693 63---------
33e8fc87
JH
64$ git fetch origin master
65$ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
4259d693 66---------
33e8fc87
JH
67
68Print a log message describing a merge of the "master" branch from
69the "origin" remote.
70
71
3c64314c
PB
72SEE ALSO
73--------
5162e697 74linkgit:git-merge[1]
3c64314c 75
3c64314c
PB
76GIT
77---
9e1f0a85 78Part of the linkgit:git[1] suite