doc/source/en/TortoiseGit/git_doc/git-cherry-pick.html.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-cherry-pick(1)">\r
   5 <articleinfo>\r
   6     <title>git-cherry-pick(1)</title>\r
   7         <indexterm>\r
   8                 <primary>git-cherry-pick(1)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-cherry-pick - Apply the change introduced by an existing commit</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <simpara><emphasis>git cherry-pick</emphasis> [--edit] [-n] [-m parent-number] [-s] [-x] &lt;commit&gt;</simpara>\r
  18 </simplesect>\r
  19 <simplesect id="_description">\r
  20 <title>DESCRIPTION</title>\r
  21 <simpara>Given one existing commit, apply the change the patch introduces, and record a\r
  22 new commit that records it.  This requires your working tree to be clean (no\r
  23 modifications from the HEAD commit).</simpara>\r
  24 </simplesect>\r
  25 <simplesect id="_options">\r
  26 <title>OPTIONS</title>\r
  27 <variablelist>\r
  28 <varlistentry>\r
  29 <term>\r
  30 &lt;commit&gt;\r
  31 </term>\r
  32 <listitem>\r
  33 <simpara>\r
  34         Commit to cherry-pick.\r
  35         For a more complete list of ways to spell commits, see the\r
  36         "SPECIFYING REVISIONS" section in <xref linkend="git-rev-parse(1)"/>.\r
  37 </simpara>\r
  38 </listitem>\r
  39 </varlistentry>\r
  40 <varlistentry>\r
  41 <term>\r
  42 -e\r
  43 </term>\r
  44 <term>\r
  45 --edit\r
  46 </term>\r
  47 <listitem>\r
  48 <simpara>\r
  49         With this option, <emphasis>git-cherry-pick</emphasis> will let you edit the commit\r
  50         message prior to committing.\r
  51 </simpara>\r
  52 </listitem>\r
  53 </varlistentry>\r
  54 <varlistentry>\r
  55 <term>\r
  56 -x\r
  57 </term>\r
  58 <listitem>\r
  59 <simpara>\r
  60         When recording the commit, append to the original commit\r
  61         message a note that indicates which commit this change\r
  62         was cherry-picked from.  Append the note only for cherry\r
  63         picks without conflicts.  Do not use this option if\r
  64         you are cherry-picking from your private branch because\r
  65         the information is useless to the recipient.  If on the\r
  66         other hand you are cherry-picking between two publicly\r
  67         visible branches (e.g. backporting a fix to a\r
  68         maintenance branch for an older release from a\r
  69         development branch), adding this information can be\r
  70         useful.\r
  71 </simpara>\r
  72 </listitem>\r
  73 </varlistentry>\r
  74 <varlistentry>\r
  75 <term>\r
  76 -r\r
  77 </term>\r
  78 <listitem>\r
  79 <simpara>\r
  80         It used to be that the command defaulted to do <literal>-x</literal>\r
  81         described above, and <literal>-r</literal> was to disable it.  Now the\r
  82         default is not to do <literal>-x</literal> so this option is a no-op.\r
  83 </simpara>\r
  84 </listitem>\r
  85 </varlistentry>\r
  86 <varlistentry>\r
  87 <term>\r
  88 -m parent-number\r
  89 </term>\r
  90 <term>\r
  91 --mainline parent-number\r
  92 </term>\r
  93 <listitem>\r
  94 <simpara>\r
  95         Usually you cannot cherry-pick a merge because you do not know which\r
  96         side of the merge should be considered the mainline.  This\r
  97         option specifies the parent number (starting from 1) of\r
  98         the mainline and allows cherry-pick to replay the change\r
  99         relative to the specified parent.\r
 100 </simpara>\r
 101 </listitem>\r
 102 </varlistentry>\r
 103 <varlistentry>\r
 104 <term>\r
 105 -n\r
 106 </term>\r
 107 <term>\r
 108 --no-commit\r
 109 </term>\r
 110 <listitem>\r
 111 <simpara>\r
 112         Usually the command automatically creates a commit.\r
 113         This flag applies the change necessary to cherry-pick\r
 114         the named commit to your working tree and the index,\r
 115         but does not make the commit.  In addition, when this\r
 116         option is used, your index does not have to match the\r
 117         HEAD commit.  The cherry-pick is done against the\r
 118         beginning state of your index.\r
 119 </simpara>\r
 120 <simpara>This is useful when cherry-picking more than one commits'\r
 121 effect to your index in a row.</simpara>\r
 122 </listitem>\r
 123 </varlistentry>\r
 124 <varlistentry>\r
 125 <term>\r
 126 -s\r
 127 </term>\r
 128 <term>\r
 129 --signoff\r
 130 </term>\r
 131 <listitem>\r
 132 <simpara>\r
 133         Add Signed-off-by line at the end of the commit message.\r
 134 </simpara>\r
 135 </listitem>\r
 136 </varlistentry>\r
 137 </variablelist>\r
 138 </simplesect>\r
 139 <simplesect id="_author">\r
 140 <title>Author</title>\r
 141 <simpara>Written by Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
 142 </simplesect>\r
 143 <simplesect id="_documentation">\r
 144 <title>Documentation</title>\r
 145 <simpara>Documentation by Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
 146 </simplesect>\r
 147 <simplesect id="_git">\r
 148 <title>GIT</title>\r
 149 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 150 </simplesect>\r
 151 </article>\r