doc/source/en/TortoiseGit/git_doc/git-fmt-merge-msg.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-fmt-merge-msg(1)">\r
   5     <title>git-fmt-merge-msg(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-fmt-merge-msg(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-fmt-merge-msg(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-fmt-merge-msg - Produce a merge commit message</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-fmt-merge-msg(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git fmt-merge-msg</emphasis> [-m &lt;message&gt;] [--log[=&lt;n&gt;] | --no-log]\r
  17 <emphasis>git fmt-merge-msg</emphasis> [-m &lt;message&gt;] [--log[=&lt;n&gt;] | --no-log] -F &lt;file&gt;</literallayout>\r
  18 </blockquote>\r
  19 </simplesect>\r
  20 <simplesect id="git-fmt-merge-msg(1)__description">\r
  21 <title>DESCRIPTION</title>\r
  22 <simpara>Takes the list of merged objects on stdin and produces a suitable\r
  23 commit message to be used for the merge commit, usually to be\r
  24 passed as the <emphasis>&lt;merge-message&gt;</emphasis> argument of <emphasis>git merge</emphasis>.</simpara>\r
  25 <simpara>This command is intended mostly for internal use by scripts\r
  26 automatically invoking <emphasis>git merge</emphasis>.</simpara>\r
  27 </simplesect>\r
  28 <simplesect id="git-fmt-merge-msg(1)__options">\r
  29 <title>OPTIONS</title>\r
  30 <variablelist>\r
  31 <varlistentry>\r
  32 <term>\r
  33 --log[=&lt;n&gt;]\r
  34 </term>\r
  35 <listitem>\r
  36 <simpara>\r
  37         In addition to branch names, populate the log message with\r
  38         one-line descriptions from the actual commits that are being\r
  39         merged.  At most &lt;n&gt; commits from each merge parent will be\r
  40         used (20 if &lt;n&gt; is omitted).  This overrides the <emphasis>merge.log</emphasis>\r
  41         configuration variable.\r
  42 </simpara>\r
  43 </listitem>\r
  44 </varlistentry>\r
  45 <varlistentry>\r
  46 <term>\r
  47 --no-log\r
  48 </term>\r
  49 <listitem>\r
  50 <simpara>\r
  51         Do not list one-line descriptions from the actual commits being\r
  52         merged.\r
  53 </simpara>\r
  54 </listitem>\r
  55 </varlistentry>\r
  56 <varlistentry>\r
  57 <term>\r
  58 --[no-]summary\r
  59 </term>\r
  60 <listitem>\r
  61 <simpara>\r
  62         Synonyms to --log and --no-log; these are deprecated and will be\r
  63         removed in the future.\r
  64 </simpara>\r
  65 </listitem>\r
  66 </varlistentry>\r
  67 <varlistentry>\r
  68 <term>\r
  69 -m &lt;message&gt;\r
  70 </term>\r
  71 <term>\r
  72 --message &lt;message&gt;\r
  73 </term>\r
  74 <listitem>\r
  75 <simpara>\r
  76         Use &lt;message&gt; instead of the branch names for the first line\r
  77         of the log message.  For use with <emphasis>--log</emphasis>.\r
  78 </simpara>\r
  79 </listitem>\r
  80 </varlistentry>\r
  81 <varlistentry>\r
  82 <term>\r
  83 -F &lt;file&gt;\r
  84 </term>\r
  85 <term>\r
  86 --file &lt;file&gt;\r
  87 </term>\r
  88 <listitem>\r
  89 <simpara>\r
  90         Take the list of merged objects from &lt;file&gt; instead of\r
  91         stdin.\r
  92 </simpara>\r
  93 </listitem>\r
  94 </varlistentry>\r
  95 </variablelist>\r
  96 </simplesect>\r
  97 <simplesect id="git-fmt-merge-msg(1)__configuration">\r
  98 <title>CONFIGURATION</title>\r
  99 <variablelist>\r
 100 <varlistentry>\r
 101 <term>\r
 102 merge.branchdesc\r
 103 </term>\r
 104 <listitem>\r
 105 <simpara>\r
 106         In addition to branch names, populate the log message with\r
 107         the branch description text associated with them.  Defaults\r
 108         to false.\r
 109 </simpara>\r
 110 </listitem>\r
 111 </varlistentry>\r
 112 <varlistentry>\r
 113 <term>\r
 114 merge.log\r
 115 </term>\r
 116 <listitem>\r
 117 <simpara>\r
 118         In addition to branch names, populate the log message with at\r
 119         most the specified number of one-line descriptions from the\r
 120         actual commits that are being merged.  Defaults to false, and\r
 121         true is a synonym for 20.\r
 122 </simpara>\r
 123 </listitem>\r
 124 </varlistentry>\r
 125 <varlistentry>\r
 126 <term>\r
 127 merge.summary\r
 128 </term>\r
 129 <listitem>\r
 130 <simpara>\r
 131         Synonym to <emphasis>merge.log</emphasis>; this is deprecated and will be removed in\r
 132         the future.\r
 133 </simpara>\r
 134 </listitem>\r
 135 </varlistentry>\r
 136 </variablelist>\r
 137 </simplesect>\r
 138 <simplesect id="git-fmt-merge-msg(1)__example">\r
 139 <title>EXAMPLE</title>\r
 140 <simpara>$ git fetch origin master\r
 141 $ git fmt-merge-msg --log &lt;$GIT_DIR/FETCH_HEAD</simpara>\r
 142 <simpara>Print a log message describing a merge of the "master" branch from\r
 143 the "origin" remote.</simpara>\r
 144 </simplesect>\r
 145 <simplesect id="git-fmt-merge-msg(1)__see_also">\r
 146 <title>SEE ALSO</title>\r
 147 <simpara><xref linkend="git-merge(1)" /></simpara>\r
 148 </simplesect>\r
 149 <simplesect id="git-fmt-merge-msg(1)__git">\r
 150 <title>GIT</title>\r
 151 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 152 </simplesect>\r
 153 </sect2>\r