builtin/branch.c: remove useless branch_get
[git/debian.git] / Documentation / git-fmt-merge-msg.txt
blob423b6e033ba512f8a8ed6fe3f0ee6ef158dd5234
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' [-m <message>] [--log[=<n>] | --no-log]
13 'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --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 command is intended mostly for internal use by scripts
22 automatically invoking 'git merge'.
24 OPTIONS
25 -------
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.
34 --no-log::
35         Do not list one-line descriptions from the actual commits being
36         merged.
38 --[no-]summary::
39         Synonyms to --log and --no-log; these are deprecated and will be
40         removed in the future.
42 -m <message>::
43 --message <message>::
44         Use <message> instead of the branch names for the first line
45         of the log message.  For use with `--log`.
47 -F <file>::
48 --file <file>::
49         Take the list of merged objects from <file> instead of
50         stdin.
52 CONFIGURATION
53 -------------
54 include::fmt-merge-msg-config.txt[]
56 merge.summary::
57         Synonym to `merge.log`; this is deprecated and will be removed in
58         the future.
60 EXAMPLES
61 --------
63 ---------
64 $ git fetch origin master
65 $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
66 ---------
68 Print a log message describing a merge of the "master" branch from
69 the "origin" remote.
72 SEE ALSO
73 --------
74 linkgit:git-merge[1]
76 GIT
77 ---
78 Part of the linkgit:git[1] suite