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>] [--into-name <branch>] [--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 --into-name <branch>::
  48         Prepare the merge message as if merging to the branch `<branch>`,
  49         instead of the name of the real branch to which the merge is made.
  50
  51 -F <file>::
  52 --file <file>::
  53         Take the list of merged objects from <file> instead of
  54         stdin.
  55
  56 CONFIGURATION
  57 -------------
  58 include::config/fmt-merge-msg.txt[]
  59
  60 merge.summary::
  61         Synonym to `merge.log`; this is deprecated and will be removed in
  62         the future.
  63
  64 EXAMPLES
  65 --------
  66
  67 ---------
  68 $ git fetch origin master
  69 $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
  70 ---------
  71
  72 Print a log message describing a merge of the "master" branch from
  73 the "origin" remote.
  74
  75
  76 SEE ALSO
  77 --------
  78 linkgit:git-merge[1]
  79
  80 GIT
  81 ---
  82 Part of the linkgit:git[1] suite