fmt_merge_msg: Change fmt_merge_msg API to accept shortlog_len
[git/git.git] / Documentation / git-fmt-merge-msg.txt
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 [verse]
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>
14
15 DESCRIPTION
16 -----------
17 Takes the list of merged objects on stdin and produces a suitable
18 commit message to be used for the merge commit, usually to be
19 passed as the '<merge-message>' argument of 'git merge'.
20
21 This command is intended mostly for internal use by scripts
22 automatically invoking 'git merge'.
23
24 OPTIONS
25 -------
26
27 --log::
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
32 --no-log::
33 Do not list one-line descriptions from the actual commits being
34 merged.
35
36 --summary::
37 --no-summary::
38 Synonyms to --log and --no-log; these are deprecated and will be
39 removed in the future.
40
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
46 -F <file>::
47 --file <file>::
48 Take the list of merged objects from <file> instead of
49 stdin.
50
51 CONFIGURATION
52 -------------
53
54 merge.log::
55 Whether to include summaries of merged commits in newly
56 merge commit messages. False by default.
57
58 merge.summary::
59 Synonym to `merge.log`; this is deprecated and will be removed in
60 the future.
61
62 SEE ALSO
63 --------
64 linkgit:git-merge[1]
65
66
67 Author
68 ------
69 Written by Junio C Hamano <gitster@pobox.com>
70
71 Documentation
72 --------------
73 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
74
75 GIT
76 ---
77 Part of the linkgit:git[1] suite