merge: Make '--log' an integer option for number of shortlog entries
[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[=<n>] | --no-log] <$GIT_DIR/FETCH_HEAD
13 'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --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[=<n>]::
28 In addition to branch names, populate the log message with
29 one-line descriptions from the actual commits that are being
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.
33
34 --no-log::
35 Do not list one-line descriptions from the actual commits being
36 merged.
37
38 --summary::
39 --no-summary::
40 Synonyms to --log and --no-log; these are deprecated and will be
41 removed in the future.
42
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
48 -F <file>::
49 --file <file>::
50 Take the list of merged objects from <file> instead of
51 stdin.
52
53 CONFIGURATION
54 -------------
55
56 merge.log::
57 Whether to include summaries of merged commits in newly
58 merge commit messages. False by default.
59
60 merge.summary::
61 Synonym to `merge.log`; this is deprecated and will be removed in
62 the future.
63
64 SEE ALSO
65 --------
66 linkgit:git-merge[1]
67
68
69 Author
70 ------
71 Written by Junio C Hamano <gitster@pobox.com>
72
73 Documentation
74 --------------
75 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
76
77 GIT
78 ---
79 Part of the linkgit:git[1] suite