git-merge: exclude unnecessary options from OPTIONS_SPEC
[git/dscho.git] / Documentation / git-fmt-merge-msg.txt
blob457cf425619dc1680fae510aceb20574b02be602
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 [--log | --no-log] <$GIT_DIR/FETCH_HEAD
13 git-fmt-merge-msg [--log | --no-log] -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 --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.
32 --no-log::
33         Do not list one-line descriptions from the actual commits being
34         merged.
36 --summary,--no-summary::
37         Synonyms to --log and --no-log; these are deprecated and will be
38         removed in the future.
40 --file <file>, -F <file>::
41         Take the list of merged objects from <file> instead of
42         stdin.
44 CONFIGURATION
45 -------------
47 merge.log::
48         Whether to include summaries of merged commits in newly
49         merge commit messages. False by default.
51 merge.summary::
52         Synonym to `merge.log`; this is deprecated and will be removed in
53         the future.
55 SEE ALSO
56 --------
57 linkgit:git-merge[1]
60 Author
61 ------
62 Written by Junio C Hamano <junkio@cox.net>
64 Documentation
65 --------------
66 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
68 GIT
69 ---
70 Part of the linkgit:git[7] suite