Documentation cherry-pick: Fix cut-and-paste error
[git/platforms/storm.git] / Documentation / git-fmt-merge-msg.txt
blob8615ae353e91fa1de0d17c7c3f8ea777ac62e209
1 git-fmt-merge-msg(1)
2 ====================
4 NAME
5 ----
6 git-fmt-merge-msg - Produce a merge commit message
9 SYNOPSIS
10 --------
11 [verse]
12 git-fmt-merge-msg [--summary | --no-summary] <$GIT_DIR/FETCH_HEAD
13 git-fmt-merge-msg [--summary | --no-summary] -F <file>
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`.
21 This script is intended mostly for internal use by scripts
22 automatically invoking `git-merge`.
24 OPTIONS
25 -------
27 --summary::
28         In addition to branch names, populate the log message with
29         one-line descriptions from the actual commits that are being
30         merged.
32 --no-summary::
33         Do not list one-line descriptions from the actual commits being
34         merged.
36 --file <file>, -F <file>::
37         Take the list of merged objects from <file> instead of
38         stdin.
40 CONFIGURATION
41 -------------
43 merge.summary::
44         Whether to include summaries of merged commits in newly
45         merge commit messages. False by default.
47 SEE ALSO
48 --------
49 linkgit:git-merge[1]
52 Author
53 ------
54 Written by Junio C Hamano <junkio@cox.net>
56 Documentation
57 --------------
58 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
60 GIT
61 ---
62 Part of the linkgit:git[7] suite