Autogenerated HTML docs for v1.7.3-rc0-38-g9ab5a
[git/jnareb-git.git] / git-cherry-pick.html
blob47ff5a2f866f3f15c73a09a50a69bce2c183070d
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-cherry-pick(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-cherry-pick(1) Manual Page
313 </h1>
314 <h2>NAME</h2>
315 <div class="sectionbody">
316 <p>git-cherry-pick -
317 Apply the changes introduced by some existing commits
318 </p>
319 </div>
320 </div>
321 <h2>SYNOPSIS</h2>
322 <div class="sectionbody">
323 <div class="para"><p><em>git cherry-pick</em> [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] &lt;commit&gt;&#8230;</p></div>
324 </div>
325 <h2 id="_description">DESCRIPTION</h2>
326 <div class="sectionbody">
327 <div class="para"><p>Given one or more existing commits, apply the change each one
328 introduces, recording a new commit for each. This requires your
329 working tree to be clean (no modifications from the HEAD commit).</p></div>
330 </div>
331 <h2 id="_options">OPTIONS</h2>
332 <div class="sectionbody">
333 <div class="vlist"><dl>
334 <dt>
335 &lt;commit&gt;&#8230;
336 </dt>
337 <dd>
339 Commits to cherry-pick.
340 For a more complete list of ways to spell commits, see
341 <a href="gitrevisions.html">gitrevisions(1)</a>.
342 Sets of commits can be passed but no traversal is done by
343 default, as if the <em>--no-walk</em> option was specified, see
344 <a href="git-rev-list.html">git-rev-list(1)</a>.
345 </p>
346 </dd>
347 <dt>
349 </dt>
350 <dt>
351 --edit
352 </dt>
353 <dd>
355 With this option, <em>git cherry-pick</em> will let you edit the commit
356 message prior to committing.
357 </p>
358 </dd>
359 <dt>
361 </dt>
362 <dd>
364 When recording the commit, append to the original commit
365 message a note that indicates which commit this change
366 was cherry-picked from. Append the note only for cherry
367 picks without conflicts. Do not use this option if
368 you are cherry-picking from your private branch because
369 the information is useless to the recipient. If on the
370 other hand you are cherry-picking between two publicly
371 visible branches (e.g. backporting a fix to a
372 maintenance branch for an older release from a
373 development branch), adding this information can be
374 useful.
375 </p>
376 </dd>
377 <dt>
379 </dt>
380 <dd>
382 It used to be that the command defaulted to do <tt>-x</tt>
383 described above, and <tt>-r</tt> was to disable it. Now the
384 default is not to do <tt>-x</tt> so this option is a no-op.
385 </p>
386 </dd>
387 <dt>
388 -m parent-number
389 </dt>
390 <dt>
391 --mainline parent-number
392 </dt>
393 <dd>
395 Usually you cannot cherry-pick a merge because you do not know which
396 side of the merge should be considered the mainline. This
397 option specifies the parent number (starting from 1) of
398 the mainline and allows cherry-pick to replay the change
399 relative to the specified parent.
400 </p>
401 </dd>
402 <dt>
404 </dt>
405 <dt>
406 --no-commit
407 </dt>
408 <dd>
410 Usually the command automatically creates a sequence of commits.
411 This flag applies the changes necessary to cherry-pick
412 each named commit to your working tree and the index,
413 without making any commit. In addition, when this
414 option is used, your index does not have to match the
415 HEAD commit. The cherry-pick is done against the
416 beginning state of your index.
417 </p>
418 <div class="para"><p>This is useful when cherry-picking more than one commits'
419 effect to your index in a row.</p></div>
420 </dd>
421 <dt>
423 </dt>
424 <dt>
425 --signoff
426 </dt>
427 <dd>
429 Add Signed-off-by line at the end of the commit message.
430 </p>
431 </dd>
432 <dt>
433 --ff
434 </dt>
435 <dd>
437 If the current HEAD is the same as the parent of the
438 cherry-pick'ed commit, then a fast forward to this commit will
439 be performed.
440 </p>
441 </dd>
442 </dl></div>
443 </div>
444 <h2 id="_examples">EXAMPLES</h2>
445 <div class="sectionbody">
446 <div class="vlist"><dl>
447 <dt>
448 git cherry-pick master
449 </dt>
450 <dd>
452 Apply the change introduced by the commit at the tip of the
453 master branch and create a new commit with this change.
454 </p>
455 </dd>
456 <dt>
457 git cherry-pick ..master
458 </dt>
459 <dt>
460 git cherry-pick ^HEAD master
461 </dt>
462 <dd>
464 Apply the changes introduced by all commits that are ancestors
465 of master but not of HEAD to produce new commits.
466 </p>
467 </dd>
468 <dt>
469 git cherry-pick master\<sub>4 master</sub>2
470 </dt>
471 <dd>
473 Apply the changes introduced by the fifth and third last
474 commits pointed to by master and create 2 new commits with
475 these changes.
476 </p>
477 </dd>
478 <dt>
479 git cherry-pick -n master~1 next
480 </dt>
481 <dd>
483 Apply to the working tree and the index the changes introduced
484 by the second last commit pointed to by master and by the last
485 commit pointed to by next, but do not create any commit with
486 these changes.
487 </p>
488 </dd>
489 <dt>
490 git cherry-pick --ff ..next
491 </dt>
492 <dd>
494 If history is linear and HEAD is an ancestor of next, update
495 the working tree and advance the HEAD pointer to match next.
496 Otherwise, apply the changes introduced by those commits that
497 are in next but not HEAD to the current branch, creating a new
498 commit for each new change.
499 </p>
500 </dd>
501 <dt>
502 git rev-list --reverse master -- README | git cherry-pick -n --stdin
503 </dt>
504 <dd>
506 Apply the changes introduced by all commits on the master
507 branch that touched README to the working tree and index,
508 so the result can be inspected and made into a single new
509 commit if suitable.
510 </p>
511 </dd>
512 </dl></div>
513 </div>
514 <h2 id="_author">Author</h2>
515 <div class="sectionbody">
516 <div class="para"><p>Written by Junio C Hamano &lt;gitster@pobox.com&gt;</p></div>
517 </div>
518 <h2 id="_documentation">Documentation</h2>
519 <div class="sectionbody">
520 <div class="para"><p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
521 </div>
522 <h2 id="_see_also">SEE ALSO</h2>
523 <div class="sectionbody">
524 <div class="para"><p><a href="git-revert.html">git-revert(1)</a></p></div>
525 </div>
526 <h2 id="_git">GIT</h2>
527 <div class="sectionbody">
528 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
529 </div>
530 <div id="footer">
531 <div id="footer-text">
532 Last updated 2010-09-03 21:30:06 UTC
533 </div>
534 </div>
535 </body>
536 </html>