fmt_merge_msg: Change fmt_merge_msg API to accept shortlog_len
[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]
2102440c
JN
12'git fmt-merge-msg' [-m <message>] [--log | --no-log] <$GIT_DIR/FETCH_HEAD
13'git fmt-merge-msg' [-m <message>] [--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
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
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
2102440c
JN
41-m <message>::
42--message <message>::
43 Use <message> instead of the branch names for the first line
44 of the log message. For use with `--log`.
45
3240240f
SB
46-F <file>::
47--file <file>::
2bc060cc
AR
48 Take the list of merged objects from <file> instead of
49 stdin.
50
51CONFIGURATION
52-------------
53
6cd9cfef 54merge.log::
2bc060cc
AR
55 Whether to include summaries of merged commits in newly
56 merge commit messages. False by default.
3c64314c 57
6cd9cfef
SG
58merge.summary::
59 Synonym to `merge.log`; this is deprecated and will be removed in
60 the future.
61
3c64314c
PB
62SEE ALSO
63--------
5162e697 64linkgit:git-merge[1]
3c64314c
PB
65
66
67Author
68------
59eb68aa 69Written by Junio C Hamano <gitster@pobox.com>
3c64314c
PB
70
71Documentation
72--------------
73Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
74
75GIT
76---
9e1f0a85 77Part of the linkgit:git[1] suite