| blob | f4c8484ec11ffbb79bd8ad41bd17a654421348e2 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-checkout(1) Manual Page
407 </h1>
410 <p>git-checkout -
411 Checkout a branch or paths to the working tree
412 </p>
413 </div>
414 </div>
419 <em>git checkout</em> [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
420 <em>git checkout</em> [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>…
423 </div></div>
424 </div>
430 branch.</p></div>
434 </dt>
437 </dt>
438 <dd>
439 <p>
440 This form switches branches by updating the index, working
441 tree, and HEAD to reflect the specified branch.
442 </p>
443 <div class="paragraph"><p>If <tt>-b</tt> is given, a new branch is created as if <a href="git-branch.html">git-branch(1)</a>
444 were called and then checked out; in this case you can
448 <div class="paragraph"><p>If <tt>-B</tt> is given, <new_branch> is created if it doesn’t exist; otherwise, it
449 is reset. This is the transactional equivalent of</p></div>
454 </div></div>
455 <div class="paragraph"><p>that is to say, the branch is not reset/created unless "git checkout" is
456 successful.</p></div>
457 </dd>
460 </dt>
461 <dd>
462 <p>
463 When <paths> or <tt>--patch</tt> are given, <em>git checkout</em> does <strong>not</strong>
464 switch branches. It updates the named paths in the working tree
467 meaningless and giving either of them results in an error. The
469 (i.e. commit, tag or tree) to update the index for the given
470 paths before updating the working tree.
471 </p>
472 <div class="paragraph"><p>The index may contain unmerged entries because of a previous failed merge.
473 By default, if you try to check out such an entry from the index, the
474 checkout operation will fail and nothing will be checked out.
476 specific side of the merge can be checked out of the index by
478 file can be discarded to re-create the original conflicted merge result.</p></div>
479 </dd>
480 </dl></div>
481 </div>
486 -q
487 </dt>
489 --quiet
490 </dt>
491 <dd>
492 <p>
493 Quiet, suppress feedback messages.
494 </p>
495 </dd>
497 -f
498 </dt>
500 --force
501 </dt>
502 <dd>
503 <p>
504 When switching branches, proceed even if the index or the
505 working tree differs from HEAD. This is used to throw away
506 local changes.
507 </p>
509 entries; instead, unmerged entries are ignored.</p></div>
510 </dd>
512 --ours
513 </dt>
515 --theirs
516 </dt>
517 <dd>
518 <p>
519 When checking out paths from the index, check out stage #2
521 </p>
522 </dd>
524 -b
525 </dt>
526 <dd>
527 <p>
530 </p>
531 </dd>
533 -B
534 </dt>
535 <dd>
536 <p>
541 </p>
542 </dd>
544 -t
545 </dt>
547 --track
548 </dt>
549 <dd>
550 <p>
551 When creating a new branch, set up "upstream" configuration. See
553 </p>
556 is prefixed it is stripped away, and then the part up to the
557 next slash (which would be the nickname of the remote) is removed.
558 This would tell us to use "hack" as the local branch when branching
560 "refs/remotes/origin/hack"). If the given name has no slash, or the above
561 guessing results in an empty name, the guessing is aborted. You can
563 </dd>
565 --no-track
566 </dt>
567 <dd>
568 <p>
569 Do not set up "upstream" configuration, even if the
570 branch.autosetupmerge configuration variable is true.
571 </p>
572 </dd>
574 -l
575 </dt>
576 <dd>
577 <p>
579 details.
580 </p>
581 </dd>
583 --orphan
584 </dt>
585 <dd>
586 <p>
589 new branch will have no parents and it will be the root of a new
590 history totally disconnected from all the other branches and
591 commits.
592 </p>
593 <div class="paragraph"><p>The index and the working tree are adjusted as if you had previously run
594 "git checkout <start_point>". This allows you to start a new history
598 without exposing its full history. You might want to do this to publish
599 an open source branch of a project whose current tree is "clean", but
600 whose full history contains proprietary or otherwise encumbered bits of
601 code.</p></div>
602 <div class="paragraph"><p>If you want to start a disconnected history that records a set of paths
604 clear the index and the working tree right after creating the orphan
605 branch by running "git rm -rf ." from the top level of the working tree.
606 Afterwards you will be ready to prepare your new files, repopulating the
607 working tree, by copying them from elsewhere, extracting a tarball, etc.</p></div>
608 </dd>
610 -m
611 </dt>
613 --merge
614 </dt>
615 <dd>
616 <p>
617 When switching branches,
618 if you have local modifications to one or more files that
619 are different between the current branch and the branch to
620 which you are switching, the command refuses to switch
621 branches in order to preserve your modifications in context.
622 However, with this option, a three-way merge between the current
623 branch, your working tree contents, and the new branch
624 is done, and you will be on the new branch.
625 </p>
627 paths are left unmerged, and you need to resolve the conflicts
629 should result in deletion of the path).</p></div>
631 the conflicted merge in the specified paths.</p></div>
632 </dd>
635 </dt>
636 <dd>
637 <p>
638 The same as --merge option above, but changes the way the
639 conflicting hunks are presented, overriding the
640 merge.conflictstyle configuration variable. Possible values are
642 "merge" style, shows the original contents).
643 </p>
644 </dd>
646 -p
647 </dt>
649 --patch
650 </dt>
651 <dd>
652 <p>
653 Interactively select hunks in the difference between the
655 tree. The chosen hunks are then applied in reverse to the
657 </p>
658 <div class="paragraph"><p>This means that you can use <tt>git checkout -p</tt> to selectively discard
659 edits from your current working tree.</p></div>
660 </dd>
663 </dt>
664 <dd>
665 <p>
666 Branch to checkout; if it refers to a branch (i.e., a name that,
667 when prepended with "refs/heads/", is a valid ref), then that
668 branch is checked out. Otherwise, if it refers to a valid
669 commit, your HEAD becomes "detached" and you are no longer on
670 any branch (see below for details).
671 </p>
672 <div class="paragraph"><p>As a special case, the <tt>"@{-N}"</tt> syntax for the N-th last branch
673 checks out the branch (instead of detaching). You may also specify
675 <div class="paragraph"><p>As a further special case, you may use <tt>"A...B"</tt> as a shortcut for the
677 leave out at most one of <tt>A</tt> and <tt>B</tt>, in which case it defaults to <tt>HEAD</tt>.</p></div>
678 </dd>
681 </dt>
682 <dd>
683 <p>
684 Name for the new branch.
685 </p>
686 </dd>
689 </dt>
690 <dd>
691 <p>
692 The name of a commit at which to start the new branch; see
694 </p>
695 </dd>
698 </dt>
699 <dd>
700 <p>
701 Tree to checkout from (when paths are given). If not specified,
702 the index will be used.
703 </p>
704 </dd>
705 </dl></div>
706 </div>
709 <div class="paragraph"><p>It is sometimes useful to be able to <em>checkout</em> a commit that is
710 not at the tip of one of your branches. The most obvious
711 example is to check out the commit at a tagged official release
712 point, like this:</p></div>
716 </div></div>
720 current branch and directly points at the commit named by the tag
724 example. You can make changes and create a new commit on top of
725 a detached HEAD. You can even create a merge by using <tt>git
728 by any branch (which is natural --- you are not on any branch).
729 What this means is that you can discard your temporary commits
730 and merges by switching back to an existing branch (e.g. <tt>git
732 garbage-collect them. If you did this by mistake, you can ask
733 the reflog for HEAD where you were, e.g.</p></div>
737 </div></div>
738 </div>
742 <li>
743 <p>
746 mistake, and gets it back from the index.
747 </p>
752 $ rm -f hello.c
754 </div></div>
756 <li>
757 <p>
758 switch branch
759 </p>
760 </li>
761 <li>
762 <p>
763 take a file out of another commit
764 </p>
765 </li>
766 <li>
767 <p>
768 restore hello.c from the index
769 </p>
770 <div class="paragraph"><p>If you have an unfortunate branch that is named <tt>hello.c</tt>, this
771 step would be confused as an instruction to switch to that branch.
772 You should instead write:</p></div>
776 </div></div>
777 </li>
778 </ol></div>
779 </li>
780 <li>
781 <p>
782 After working in the wrong branch, switching to the correct
783 branch would be done using:
784 </p>
788 </div></div>
790 differ in files that you have modified locally, in which case
791 the above checkout would fail like this:</p></div>
794 <pre><tt>$ git checkout mytopic
795 error: You have local changes to 'frotz'; not switching branches.</tt></pre>
796 </div></div>
798 three-way merge:</p></div>
801 <pre><tt>$ git checkout -m mytopic
802 Auto-merging frotz</tt></pre>
803 </div></div>
806 changes you made since the tip of the new branch.</p></div>
807 </li>
808 <li>
809 <p>
810 When a merge conflict happens during switching branches with
812 </p>
815 <pre><tt>$ git checkout -m mytopic
816 Auto-merging frotz
817 ERROR: Merge conflict in frotz
818 fatal: merge program failed</tt></pre>
819 </div></div>
820 <div class="paragraph"><p>At this point, <tt>git diff</tt> shows the changes cleanly merged as in
821 the previous example, as well as the changes in the conflicted
822 files. Edit and resolve the conflict and mark it resolved with
826 <pre><tt>$ edit frotz
827 $ git add frotz</tt></pre>
828 </div></div>
829 </li>
830 </ol></div>
831 </div>
834 <div class="paragraph"><p>Written by Linus Torvalds <<a href="mailto:torvalds@osdl.org">torvalds@osdl.org</a>></p></div>
835 </div>
838 <div class="paragraph"><p>Documentation by Junio C Hamano and the git-list <<a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>>.</p></div>
839 </div>
843 </div>
847 </div>
848 </div>
849 </body>
850 </html>