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' [-m <message>] [--log[=<n>] | --no-log]
  13 'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --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[=<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.
  33
  34 --no-log::
  35         Do not list one-line descriptions from the actual commits being
  36         merged.
  37
  38 --[no-]summary::
  39         Synonyms to --log and --no-log; these are deprecated and will be
  40         removed in the future.
  41
  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`.
  46
  47 -F <file>::
  48 --file <file>::
  49         Take the list of merged objects from <file> instead of
  50         stdin.
  51
  52 CONFIGURATION
  53 -------------
  54 include::fmt-merge-msg-config.txt[]
  55
  56 merge.summary::
  57         Synonym to `merge.log`; this is deprecated and will be removed in
  58         the future.
  59
  60 EXAMPLE
  61 -------
  62
  63 ---------
  64 $ git fetch origin master
  65 $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
  66 ---------
  67
  68 Print a log message describing a merge of the "master" branch from
  69 the "origin" remote.
  70
  71
  72 SEE ALSO
  73 --------
  74 linkgit:git-merge[1]
  75
  76 GIT
  77 ---
  78 Part of the linkgit:git[1] suite