Fix minor documentation errors
[git/git-p4.git] / Documentation / git-fmt-merge-msg.txt
blobe560b30c571c793bff428ec32ca510bec7595155
1 git-fmt-merge-msg(1)
2 ====================
4 NAME
5 ----
6 git-fmt-merge-msg - Produce a merge commit message
9 SYNOPSIS
10 --------
11 git-fmt-merge-msg [--summary | --no-summary] <$GIT_DIR/FETCH_HEAD
12 git-fmt-merge-msg [--summary | --no-summray] -F <file>
14 DESCRIPTION
15 -----------
16 Takes the list of merged objects on stdin and produces a suitable
17 commit message to be used for the merge commit, usually to be
18 passed as the '<merge-message>' argument of `git-merge`.
20 This script is intended mostly for internal use by scripts
21 automatically invoking `git-merge`.
23 OPTIONS
24 -------
26 --summary::
27         In addition to branch names, populate the log message with
28         one-line descriptions from the actual commits that are being
29         merged.
31 --no-summary::
32         Do not list one-line descriptions from the actual commits being
33         merged.
35 --file <file>, -F <file>::
36         Take the list of merged objects from <file> instead of
37         stdin.
39 CONFIGURATION
40 -------------
42 merge.summary::
43         Whether to include summaries of merged commits in newly
44         merge commit messages. False by default.
46 SEE ALSO
47 --------
48 gitlink:git-merge[1]
51 Author
52 ------
53 Written by Junio C Hamano <junkio@cox.net>
55 Documentation
56 --------------
57 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
59 GIT
60 ---
61 Part of the gitlink:git[7] suite