Documentation: git fmt-merge-msg does not have to be a script
[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' [--log | --no-log] <$GIT_DIR/FETCH_HEAD
13 'git fmt-merge-msg' [--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 -F <file>::
42 --file <file>::
43 Take the list of merged objects from <file> instead of
44 stdin.
45
46 CONFIGURATION
47 -------------
48
49 merge.log::
50 Whether to include summaries of merged commits in newly
51 merge commit messages. False by default.
52
53 merge.summary::
54 Synonym to `merge.log`; this is deprecated and will be removed in
55 the future.
56
57 SEE ALSO
58 --------
59 linkgit:git-merge[1]
60
61
62 Author
63 ------
64 Written by Junio C Hamano <gitster@pobox.com>
65
66 Documentation
67 --------------
68 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
69
70 GIT
71 ---
72 Part of the linkgit:git[1] suite