2005-09-08 00:26:23 +00:00
|
|
|
git-checkout(1)
|
|
|
|
===============
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2015-06-17 07:54:51 +00:00
|
|
|
git-checkout - Switch branches or restore working tree files
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2006-03-18 00:26:01 +00:00
|
|
|
[verse]
|
2009-04-13 11:19:33 +00:00
|
|
|
'git checkout' [-q] [-f] [-m] [<branch>]
|
2013-09-11 17:05:17 +00:00
|
|
|
'git checkout' [-q] [-f] [-m] --detach [<branch>]
|
|
|
|
'git checkout' [-q] [-f] [-m] [--detach] <commit>
|
2021-11-06 18:48:52 +00:00
|
|
|
'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new-branch>] [<start-point>]
|
2019-12-03 14:02:16 +00:00
|
|
|
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...
|
2019-12-03 14:02:18 +00:00
|
|
|
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]
|
2019-12-03 14:02:16 +00:00
|
|
|
'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2010-06-01 07:25:23 +00:00
|
|
|
Updates files in the working tree to match the version in the index
|
2019-12-03 14:02:16 +00:00
|
|
|
or the specified tree. If no pathspec was given, 'git checkout' will
|
2010-06-01 07:25:23 +00:00
|
|
|
also update `HEAD` to set the specified branch as the current
|
2009-04-13 11:19:33 +00:00
|
|
|
branch.
|
2005-10-18 08:29:27 +00:00
|
|
|
|
2019-03-29 10:38:54 +00:00
|
|
|
'git checkout' [<branch>]::
|
2019-03-29 10:38:56 +00:00
|
|
|
To prepare for working on `<branch>`, switch to it by updating
|
2012-12-17 06:45:01 +00:00
|
|
|
the index and the files in the working tree, and by pointing
|
2019-03-29 10:38:56 +00:00
|
|
|
`HEAD` at the branch. Local modifications to the files in the
|
2012-12-17 06:45:01 +00:00
|
|
|
working tree are kept, so that they can be committed to the
|
2019-03-29 10:38:56 +00:00
|
|
|
`<branch>`.
|
2012-12-17 06:45:01 +00:00
|
|
|
+
|
2019-03-29 10:38:56 +00:00
|
|
|
If `<branch>` is not found but there does exist a tracking branch in
|
2019-03-29 10:39:13 +00:00
|
|
|
exactly one remote (call it `<remote>`) with a matching name and
|
|
|
|
`--no-guess` is not specified, treat as equivalent to
|
2012-12-17 06:45:02 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git checkout -b <branch> --track <remote>/<branch>
|
|
|
|
------------
|
|
|
|
+
|
2019-03-29 10:38:56 +00:00
|
|
|
You could omit `<branch>`, in which case the command degenerates to
|
2017-09-12 22:58:39 +00:00
|
|
|
"check out the current branch", which is a glorified no-op with
|
2012-12-17 06:45:01 +00:00
|
|
|
rather expensive side-effects to show only the tracking information,
|
|
|
|
if exists, for the current branch.
|
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
'git checkout' -b|-B <new-branch> [<start-point>]::
|
2005-10-18 08:29:27 +00:00
|
|
|
|
2012-12-17 06:45:01 +00:00
|
|
|
Specifying `-b` causes a new branch to be created as if
|
|
|
|
linkgit:git-branch[1] were called and then checked out. In
|
|
|
|
this case you can use the `--track` or `--no-track` options,
|
|
|
|
which will be passed to 'git branch'. As a convenience,
|
|
|
|
`--track` without `-b` implies branch creation; see the
|
|
|
|
description of `--track` below.
|
2010-06-23 19:29:00 +00:00
|
|
|
+
|
2021-11-06 18:48:52 +00:00
|
|
|
If `-B` is given, `<new-branch>` is created if it doesn't exist; otherwise, it
|
2010-06-23 19:29:00 +00:00
|
|
|
is reset. This is the transactional equivalent of
|
|
|
|
+
|
|
|
|
------------
|
2021-11-06 18:48:52 +00:00
|
|
|
$ git branch -f <branch> [<start-point>]
|
2010-06-23 19:29:00 +00:00
|
|
|
$ git checkout <branch>
|
|
|
|
------------
|
|
|
|
+
|
|
|
|
that is to say, the branch is not reset/created unless "git checkout" is
|
|
|
|
successful.
|
2008-08-09 14:00:12 +00:00
|
|
|
|
2012-12-17 06:45:01 +00:00
|
|
|
'git checkout' --detach [<branch>]::
|
2013-09-11 17:05:17 +00:00
|
|
|
'git checkout' [--detach] <commit>::
|
2012-12-17 06:45:01 +00:00
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
Prepare to work on top of `<commit>`, by detaching `HEAD` at it
|
2012-12-17 06:45:01 +00:00
|
|
|
(see "DETACHED HEAD" section), and updating the index and the
|
|
|
|
files in the working tree. Local modifications to the files
|
|
|
|
in the working tree are kept, so that the resulting working
|
|
|
|
tree will be the state recorded in the commit plus the local
|
|
|
|
modifications.
|
|
|
|
+
|
2019-03-29 10:38:56 +00:00
|
|
|
When the `<commit>` argument is a branch name, the `--detach` option can
|
|
|
|
be used to detach `HEAD` at the tip of the branch (`git checkout
|
|
|
|
<branch>` would check out that branch without detaching `HEAD`).
|
2013-09-11 17:05:17 +00:00
|
|
|
+
|
2019-03-29 10:38:56 +00:00
|
|
|
Omitting `<branch>` detaches `HEAD` at the tip of the current branch.
|
2012-12-17 06:45:01 +00:00
|
|
|
|
2019-12-03 14:02:16 +00:00
|
|
|
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...::
|
2019-12-03 14:02:18 +00:00
|
|
|
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]::
|
2005-10-18 08:29:27 +00:00
|
|
|
|
2019-12-03 14:02:16 +00:00
|
|
|
Overwrite the contents of the files that match the pathspec.
|
|
|
|
When the `<tree-ish>` (most often a commit) is not given,
|
|
|
|
overwrite working tree with the contents in the index.
|
|
|
|
When the `<tree-ish>` is given, overwrite both the index and
|
|
|
|
the working tree with the contents at the `<tree-ish>`.
|
2015-06-17 07:54:51 +00:00
|
|
|
+
|
2010-06-01 07:25:23 +00:00
|
|
|
The index may contain unmerged entries because of a previous failed merge.
|
|
|
|
By default, if you try to check out such an entry from the index, the
|
2008-08-30 14:46:55 +00:00
|
|
|
checkout operation will fail and nothing will be checked out.
|
2010-06-01 07:25:23 +00:00
|
|
|
Using `-f` will ignore these unmerged entries. The contents from a
|
2008-08-30 14:48:18 +00:00
|
|
|
specific side of the merge can be checked out of the index by
|
2010-06-01 07:25:23 +00:00
|
|
|
using `--ours` or `--theirs`. With `-m`, changes made to the working tree
|
|
|
|
file can be discarded to re-create the original conflicted merge result.
|
2005-08-23 08:49:47 +00:00
|
|
|
|
checkout doc: clarify command line args for "checkout paths" mode
There are "git checkout [-p][<tree-ish>][--][<paths>...]" in the
SYNOPSIS section, and "git checkout [-p][<tree-ish>][--]<paths>..."
as the header for the section that explains the "check out paths
from index/tree-ish" mode. It is unclear if we require at least one
path, or it is entirely optional.
Actually, both are wrong. Without the "-p(atch)" option, you must
have <pathspec> (otherwise, with a commit that is a <tree-ish>, you
would be checking out that commit to build a new history on top of
it). With it, it is already clear that you are checking out paths,
it is optional. In other words, you cannot omit both.
The source of the confusion is that -p(atch) is described as if it
is just another "optional" part and its description is lumped
together with the non patch mode, even though the actual end user
experience is vastly different.
Let's split the entry into two, and describe the regular mode and
the patch mode separately. This allows us to make it clear that the
regular mode MUST be given at least one pathspec, that the patch
mode can be invoked with either '-p' or '--patch' but one of these
must be given, and that the pathspec is entirely optional in the
patch mode.
Also, revamp the explanation of "checkout paths" by removing
extraneous description at the beginning, that says "checking out
paths is not checking out a branch". Explaining what it is for and
when the user wants to use it upfront is the most direct way to help
the readers.
Noticed-by: Robert P J Day
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-10-11 02:21:03 +00:00
|
|
|
'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]::
|
2019-12-03 14:02:15 +00:00
|
|
|
This is similar to the previous mode, but lets you use the
|
|
|
|
interactive interface to show the "diff" output and choose which
|
|
|
|
hunks to use in the result. See below for the description of
|
|
|
|
`--patch` option.
|
checkout doc: clarify command line args for "checkout paths" mode
There are "git checkout [-p][<tree-ish>][--][<paths>...]" in the
SYNOPSIS section, and "git checkout [-p][<tree-ish>][--]<paths>..."
as the header for the section that explains the "check out paths
from index/tree-ish" mode. It is unclear if we require at least one
path, or it is entirely optional.
Actually, both are wrong. Without the "-p(atch)" option, you must
have <pathspec> (otherwise, with a commit that is a <tree-ish>, you
would be checking out that commit to build a new history on top of
it). With it, it is already clear that you are checking out paths,
it is optional. In other words, you cannot omit both.
The source of the confusion is that -p(atch) is described as if it
is just another "optional" part and its description is lumped
together with the non patch mode, even though the actual end user
experience is vastly different.
Let's split the entry into two, and describe the regular mode and
the patch mode separately. This allows us to make it clear that the
regular mode MUST be given at least one pathspec, that the patch
mode can be invoked with either '-p' or '--patch' but one of these
must be given, and that the pathspec is entirely optional in the
patch mode.
Also, revamp the explanation of "checkout paths" by removing
extraneous description at the beginning, that says "checking out
paths is not checking out a branch". Explaining what it is for and
when the user wants to use it upfront is the most direct way to help
the readers.
Noticed-by: Robert P J Day
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-10-11 02:21:03 +00:00
|
|
|
|
2005-08-23 08:49:47 +00:00
|
|
|
OPTIONS
|
|
|
|
-------
|
2007-02-01 17:31:26 +00:00
|
|
|
-q::
|
2009-08-29 09:05:00 +00:00
|
|
|
--quiet::
|
2007-08-20 02:27:52 +00:00
|
|
|
Quiet, suppress feedback messages.
|
2007-02-01 17:31:26 +00:00
|
|
|
|
2019-03-29 10:38:53 +00:00
|
|
|
--progress::
|
|
|
|
--no-progress::
|
2015-11-01 21:19:05 +00:00
|
|
|
Progress status is reported on the standard error stream
|
|
|
|
by default when it is attached to a terminal, unless `--quiet`
|
|
|
|
is specified. This flag enables progress reporting even if not
|
|
|
|
attached to a terminal, regardless of `--quiet`.
|
|
|
|
|
2005-09-07 21:17:18 +00:00
|
|
|
-f::
|
2009-08-29 09:05:00 +00:00
|
|
|
--force::
|
2008-08-30 14:46:55 +00:00
|
|
|
When switching branches, proceed even if the index or the
|
2021-09-27 16:33:48 +00:00
|
|
|
working tree differs from `HEAD`, and even if there are untracked
|
|
|
|
files in the way. This is used to throw away local changes and
|
|
|
|
any untracked files or directories that are in the way.
|
2008-08-30 14:46:55 +00:00
|
|
|
+
|
|
|
|
When checking out paths from the index, do not fail upon unmerged
|
|
|
|
entries; instead, unmerged entries are ignored.
|
2005-09-07 21:17:18 +00:00
|
|
|
|
2008-08-30 14:48:18 +00:00
|
|
|
--ours::
|
|
|
|
--theirs::
|
|
|
|
When checking out paths from the index, check out stage #2
|
|
|
|
('ours') or #3 ('theirs') for unmerged paths.
|
2015-07-10 20:07:11 +00:00
|
|
|
+
|
|
|
|
Note that during `git rebase` and `git pull --rebase`, 'ours' and
|
|
|
|
'theirs' may appear swapped; `--ours` gives the version from the
|
|
|
|
branch the changes are rebased onto, while `--theirs` gives the
|
|
|
|
version from the branch that holds your work that is being rebased.
|
|
|
|
+
|
|
|
|
This is because `rebase` is used in a workflow that treats the
|
|
|
|
history at the remote as the shared canonical one, and treats the
|
|
|
|
work done on the branch you are rebasing as the third-party work to
|
|
|
|
be integrated, and you are temporarily assuming the role of the
|
|
|
|
keeper of the canonical history during the rebase. As the keeper of
|
|
|
|
the canonical history, you need to view the history from the remote
|
|
|
|
as `ours` (i.e. "our shared canonical history"), while what you did
|
|
|
|
on your side branch as `theirs` (i.e. "one contributor's work on top
|
|
|
|
of it").
|
2005-09-07 21:17:18 +00:00
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
-b <new-branch>::
|
|
|
|
Create a new branch named `<new-branch>` and start it at
|
|
|
|
`<start-point>`; see linkgit:git-branch[1] for details.
|
2005-08-23 08:49:47 +00:00
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
-B <new-branch>::
|
|
|
|
Creates the branch `<new-branch>` and start it at `<start-point>`;
|
|
|
|
if it already exists, then reset it to `<start-point>`. This is
|
2010-06-23 19:29:00 +00:00
|
|
|
equivalent to running "git branch" with "-f"; see
|
|
|
|
linkgit:git-branch[1] for details.
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-t::
|
2022-01-20 12:35:54 +00:00
|
|
|
--track[=(direct|inherit)]::
|
2009-04-13 11:18:52 +00:00
|
|
|
When creating a new branch, set up "upstream" configuration. See
|
|
|
|
"--track" in linkgit:git-branch[1] for details.
|
2008-08-09 14:00:12 +00:00
|
|
|
+
|
2016-06-28 11:40:10 +00:00
|
|
|
If no `-b` option is given, the name of the new branch will be
|
checkout: Use remote refspecs when DWIMming tracking branches
The DWIM mode of checkout allows you to run "git checkout foo" when there
is no existing local ref or path called "foo", and there is exactly _one_
remote with a remote-tracking branch called "foo". Git will automatically
create a new local branch called "foo" using the remote-tracking "foo" as
its starting point and configured upstream.
For example, consider the following unconventional (but perfectly valid)
remote setup:
[remote "origin"]
fetch = refs/heads/*:refs/remotes/origin/*
[remote "frotz"]
fetch = refs/heads/*:refs/remotes/frotz/nitfol/*
Case 1: Assume both "origin" and "frotz" have remote-tracking branches called
"foo", at "refs/remotes/origin/foo" and "refs/remotes/frotz/nitfol/foo"
respectively. In this case "git checkout foo" should fail, because there is
more than one remote with a "foo" branch.
Case 2: Assume only "frotz" have a remote-tracking branch called "foo". In
this case "git checkout foo" should succeed, and create a local branch "foo"
from "refs/remotes/frotz/nitfol/foo", using remote branch "foo" from "frotz"
as its upstream.
The current code hardcodes the assumption that all remote-tracking branches
must match the "refs/remotes/$remote/*" pattern (which is true for remotes
with "conventional" refspecs, but not true for the "frotz" remote above).
When running "git checkout foo", the current code looks for exactly one ref
matching "refs/remotes/*/foo", hence in the above example, it fails to find
"refs/remotes/frotz/nitfol/foo", which causes it to fail both case #1 and #2.
The better way to handle the above example is to actually study the fetch
refspecs to deduce the candidate remote-tracking branches for "foo"; i.e.
assume "foo" is a remote branch being fetched, and then map "refs/heads/foo"
through the refspecs in order to get the corresponding remote-tracking
branches "refs/remotes/origin/foo" and "refs/remotes/frotz/nitfol/foo".
Finally we check which of these happens to exist in the local repo, and
if there is exactly one, we have an unambiguous match for "git checkout foo",
and may proceed.
This fixes most of the failing tests introduced in the previous patch.
Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-04-21 21:52:01 +00:00
|
|
|
derived from the remote-tracking branch, by looking at the local part of
|
|
|
|
the refspec configured for the corresponding remote, and then stripping
|
|
|
|
the initial part up to the "*".
|
2019-03-29 10:38:56 +00:00
|
|
|
This would tell us to use `hack` as the local branch when branching
|
|
|
|
off of `origin/hack` (or `remotes/origin/hack`, or even
|
|
|
|
`refs/remotes/origin/hack`). If the given name has no slash, or the above
|
2008-08-21 17:23:20 +00:00
|
|
|
guessing results in an empty name, the guessing is aborted. You can
|
2016-06-28 11:40:10 +00:00
|
|
|
explicitly give a name with `-b` in such a case.
|
2007-03-08 09:58:35 +00:00
|
|
|
|
|
|
|
--no-track::
|
2009-04-13 11:11:56 +00:00
|
|
|
Do not set up "upstream" configuration, even if the
|
2019-03-29 10:38:56 +00:00
|
|
|
`branch.autoSetupMerge` configuration variable is true.
|
2007-03-08 09:58:35 +00:00
|
|
|
|
2019-03-29 10:39:13 +00:00
|
|
|
--guess::
|
|
|
|
--no-guess::
|
|
|
|
If `<branch>` is not found but there does exist a tracking
|
|
|
|
branch in exactly one remote (call it `<remote>`) with a
|
|
|
|
matching name, treat as equivalent to
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git checkout -b <branch> --track <remote>/<branch>
|
|
|
|
------------
|
|
|
|
+
|
|
|
|
If the branch exists in multiple remotes and one of them is named by
|
|
|
|
the `checkout.defaultRemote` configuration variable, we'll use that
|
|
|
|
one for the purposes of disambiguation, even if the `<branch>` isn't
|
|
|
|
unique across all remotes. Set it to
|
|
|
|
e.g. `checkout.defaultRemote=origin` to always checkout remote
|
|
|
|
branches from there if `<branch>` is ambiguous but exists on the
|
|
|
|
'origin' remote. See also `checkout.defaultRemote` in
|
|
|
|
linkgit:git-config[1].
|
|
|
|
+
|
2020-10-08 05:48:15 +00:00
|
|
|
`--guess` is the default behavior. Use `--no-guess` to disable it.
|
|
|
|
+
|
|
|
|
The default behavior can be set via the `checkout.guess` configuration
|
|
|
|
variable.
|
2007-03-08 09:58:35 +00:00
|
|
|
|
2006-05-19 09:17:16 +00:00
|
|
|
-l::
|
2009-04-13 11:18:52 +00:00
|
|
|
Create the new branch's reflog; see linkgit:git-branch[1] for
|
|
|
|
details.
|
2006-05-19 09:17:16 +00:00
|
|
|
|
2020-09-07 00:02:20 +00:00
|
|
|
-d::
|
2011-02-08 10:32:49 +00:00
|
|
|
--detach::
|
|
|
|
Rather than checking out a branch to work on it, check out a
|
|
|
|
commit for inspection and discardable experiments.
|
2019-03-29 10:38:56 +00:00
|
|
|
This is the default behavior of `git checkout <commit>` when
|
|
|
|
`<commit>` is not a branch name. See the "DETACHED HEAD" section
|
2011-02-08 10:32:49 +00:00
|
|
|
below for details.
|
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
--orphan <new-branch>::
|
|
|
|
Create a new 'orphan' branch, named `<new-branch>`, started from
|
|
|
|
`<start-point>` and switch to it. The first commit made on this
|
2010-05-22 00:28:35 +00:00
|
|
|
new branch will have no parents and it will be the root of a new
|
|
|
|
history totally disconnected from all the other branches and
|
|
|
|
commits.
|
2010-03-21 15:34:38 +00:00
|
|
|
+
|
2010-05-22 00:28:35 +00:00
|
|
|
The index and the working tree are adjusted as if you had previously run
|
2021-11-06 18:48:52 +00:00
|
|
|
`git checkout <start-point>`. This allows you to start a new history
|
|
|
|
that records a set of paths similar to `<start-point>` by easily running
|
2019-03-29 10:38:56 +00:00
|
|
|
`git commit -a` to make the root commit.
|
2010-03-21 15:34:38 +00:00
|
|
|
+
|
2010-05-22 00:28:35 +00:00
|
|
|
This can be useful when you want to publish the tree from a commit
|
|
|
|
without exposing its full history. You might want to do this to publish
|
|
|
|
an open source branch of a project whose current tree is "clean", but
|
|
|
|
whose full history contains proprietary or otherwise encumbered bits of
|
|
|
|
code.
|
|
|
|
+
|
|
|
|
If you want to start a disconnected history that records a set of paths
|
2021-11-06 18:48:52 +00:00
|
|
|
that is totally different from the one of `<start-point>`, then you should
|
2010-05-22 00:28:35 +00:00
|
|
|
clear the index and the working tree right after creating the orphan
|
2019-03-29 10:38:56 +00:00
|
|
|
branch by running `git rm -rf .` from the top level of the working tree.
|
2010-05-22 00:28:35 +00:00
|
|
|
Afterwards you will be ready to prepare your new files, repopulating the
|
|
|
|
working tree, by copying them from elsewhere, extracting a tarball, etc.
|
2010-03-21 15:34:38 +00:00
|
|
|
|
2013-04-12 23:12:08 +00:00
|
|
|
--ignore-skip-worktree-bits::
|
|
|
|
In sparse checkout mode, `git checkout -- <paths>` would
|
2019-03-29 10:38:56 +00:00
|
|
|
update only entries matched by `<paths>` and sparse patterns
|
|
|
|
in `$GIT_DIR/info/sparse-checkout`. This option ignores
|
|
|
|
the sparse patterns and adds back any files in `<paths>`.
|
2013-04-12 23:12:08 +00:00
|
|
|
|
2006-01-12 22:04:36 +00:00
|
|
|
-m::
|
2008-09-01 02:32:40 +00:00
|
|
|
--merge::
|
2008-08-30 14:52:24 +00:00
|
|
|
When switching branches,
|
|
|
|
if you have local modifications to one or more files that
|
2006-03-18 00:26:01 +00:00
|
|
|
are different between the current branch and the branch to
|
|
|
|
which you are switching, the command refuses to switch
|
|
|
|
branches in order to preserve your modifications in context.
|
|
|
|
However, with this option, a three-way merge between the current
|
2006-01-12 22:04:36 +00:00
|
|
|
branch, your working tree contents, and the new branch
|
|
|
|
is done, and you will be on the new branch.
|
|
|
|
+
|
|
|
|
When a merge conflict happens, the index entries for conflicting
|
|
|
|
paths are left unmerged, and you need to resolve the conflicts
|
2007-02-17 09:43:42 +00:00
|
|
|
and mark the resolved paths with `git add` (or `git rm` if the merge
|
|
|
|
should result in deletion of the path).
|
2008-08-30 14:52:24 +00:00
|
|
|
+
|
|
|
|
When checking out paths from the index, this option lets you recreate
|
|
|
|
the conflicted merge in the specified paths.
|
checkout.txt: note about losing staged changes with --merge
If you have staged changes in path A and perform 'checkout
--merge' (which could result in conflicts in a totally unrelated path
B), changes in A will be gone. Which is unexpected. We are supposed
to keep all changes, or kick and scream otherwise.
This is the result of how --merge is implemented, from the very first
day in 1be0659efc (checkout: merge local modifications while switching
branches., 2006-01-12):
1. a merge is done, unmerged entries are collected
2. a hard switch to a new branch is done, then unmerged entries added
back
There is no trivial fix for this. Going with 3-way merge one file at a
time loses rename detection. Going with 3-way merge by trees requires
teaching the algorithm to pick up staged changes. And even if we detect
staged changes with --merge and abort for safety, an option to continue
--merge is very weird. Such an option would keep worktree changes, but
drop staged changes.
Because the problem has been with us since the introduction of --merge
and everybody has been pretty happy (except Phillip, who found this
problem), I'll just take a note here to acknowledge it and wait for
merge wizards to come in and work their magic. There may be a way
forward [1].
[1] CABPp-BFoL_U=bzON4SEMaQSKU2TKwnOgNqjt5MUaOejTKGUJxw@mail.gmail.com
Reported-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-03-19 09:39:10 +00:00
|
|
|
+
|
|
|
|
When switching branches with `--merge`, staged changes may be lost.
|
2006-01-12 22:04:36 +00:00
|
|
|
|
2008-09-01 02:32:40 +00:00
|
|
|
--conflict=<style>::
|
2019-03-29 10:38:56 +00:00
|
|
|
The same as `--merge` option above, but changes the way the
|
2008-09-01 02:32:40 +00:00
|
|
|
conflicting hunks are presented, overriding the
|
2019-03-29 10:38:56 +00:00
|
|
|
`merge.conflictStyle` configuration variable. Possible values are
|
2021-12-01 00:05:07 +00:00
|
|
|
"merge" (default), "diff3", and "zdiff3".
|
2006-01-12 22:04:36 +00:00
|
|
|
|
2009-08-15 11:48:30 +00:00
|
|
|
-p::
|
|
|
|
--patch::
|
|
|
|
Interactively select hunks in the difference between the
|
2019-03-29 10:38:56 +00:00
|
|
|
`<tree-ish>` (or the index, if unspecified) and the working
|
2009-08-15 11:48:30 +00:00
|
|
|
tree. The chosen hunks are then applied in reverse to the
|
2019-03-29 10:38:56 +00:00
|
|
|
working tree (and if a `<tree-ish>` was specified, the index).
|
2009-08-15 11:48:30 +00:00
|
|
|
+
|
|
|
|
This means that you can use `git checkout -p` to selectively discard
|
2011-05-05 18:48:48 +00:00
|
|
|
edits from your current working tree. See the ``Interactive Mode''
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 08:51:57 +00:00
|
|
|
section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
|
checkout: introduce --{,no-}overlay option
Currently 'git checkout' is defined as an overlay operation, which
means that if in 'git checkout <tree-ish> -- [<pathspec>]' we have an
entry in the index that matches <pathspec>, but that doesn't exist in
<tree-ish>, that entry will not be removed from the index or the
working tree.
Introduce a new --{,no-}overlay option, which allows using 'git
checkout' in non-overlay mode, thus removing files from the working
tree if they do not exist in <tree-ish> but match <pathspec>.
Note that 'git checkout -p <tree-ish> -- [<pathspec>]' already works
this way, so no changes are needed for the patch mode. We disallow
'git checkout --overlay -p' to avoid confusing users who would expect
to be able to force overlay mode in 'git checkout -p' this way.
Untracked files are not affected by this change, so 'git checkout
--no-overlay HEAD -- untracked' will not remove untracked from the
working tree. This is so e.g. 'git checkout --no-overlay HEAD -- dir/'
doesn't delete all untracked files in dir/, but rather just resets the
state of files that are known to git.
Suggested-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-01-08 21:52:24 +00:00
|
|
|
+
|
|
|
|
Note that this option uses the no overlay mode by default (see also
|
2019-03-29 10:38:53 +00:00
|
|
|
`--overlay`), and currently doesn't support overlay mode.
|
2009-08-15 11:48:30 +00:00
|
|
|
|
2015-01-03 09:41:26 +00:00
|
|
|
--ignore-other-worktrees::
|
|
|
|
`git checkout` refuses when the wanted ref is already checked
|
|
|
|
out by another worktree. This option makes it check the ref
|
|
|
|
out anyway. In other words, the ref can be held by more than one
|
|
|
|
worktree.
|
|
|
|
|
2019-03-29 10:38:55 +00:00
|
|
|
--overwrite-ignore::
|
|
|
|
--no-overwrite-ignore::
|
|
|
|
Silently overwrite ignored files when switching branches. This
|
|
|
|
is the default behavior. Use `--no-overwrite-ignore` to abort
|
|
|
|
the operation when the new branch contains ignored files.
|
|
|
|
|
2019-03-29 10:38:53 +00:00
|
|
|
--recurse-submodules::
|
|
|
|
--no-recurse-submodules::
|
doc: --recurse-submodules mostly applies to active submodules
The documentation refers to "initialized" or "populated" submodules,
to explain which submodules are affected by '--recurse-submodules', but
the real terminology here is 'active' submodules. Update the
documentation accordingly.
Some terminology:
- Active is defined in gitsubmodules(7), it only involves the
configuration variables 'submodule.active', 'submodule.<name>.active'
and 'submodule.<name>.url'. The function
submodule.c::is_submodule_active checks that a submodule is active.
- Populated means that the submodule's working tree is present (and the
gitfile correctly points to the submodule repository), i.e. either the
superproject was cloned with ` --recurse-submodules`, or the user ran
`git submodule update --init`, or `git submodule init [<path>]` and
`git submodule update [<path>]` separately which populated the
submodule working tree. This does not involve the 3 configuration
variables above.
- Initialized (at least in the context of the man pages involved in this
patch) means both "populated" and "active" as defined above, i.e. what
`git submodule update --init` does.
The --recurse-submodules option mostly affects active submodules. An
exception is `git fetch` where the option affects populated submodules.
As a consequence, in `git pull --recurse-submodules` the fetch affects
populated submodules, but the resulting working tree update only affects
active submodules.
In the documentation of `git-pull`, let's distinguish between the
fetching part which affects populated submodules, and the updating of
worktrees, which only affects active submodules.
Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com>
Helped-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-04-06 13:57:09 +00:00
|
|
|
Using `--recurse-submodules` will update the content of all active
|
2017-03-14 21:46:41 +00:00
|
|
|
submodules according to the commit recorded in the superproject. If
|
|
|
|
local modifications in a submodule would be overwritten the checkout
|
2019-03-29 10:38:56 +00:00
|
|
|
will fail unless `-f` is used. If nothing (or `--no-recurse-submodules`)
|
2020-04-06 13:57:06 +00:00
|
|
|
is used, submodules working trees will not be updated.
|
2019-03-29 10:38:56 +00:00
|
|
|
Just like linkgit:git-submodule[1], this will detach `HEAD` of the
|
|
|
|
submodule.
|
2018-11-13 17:52:26 +00:00
|
|
|
|
2019-03-29 10:38:53 +00:00
|
|
|
--overlay::
|
|
|
|
--no-overlay::
|
checkout: introduce --{,no-}overlay option
Currently 'git checkout' is defined as an overlay operation, which
means that if in 'git checkout <tree-ish> -- [<pathspec>]' we have an
entry in the index that matches <pathspec>, but that doesn't exist in
<tree-ish>, that entry will not be removed from the index or the
working tree.
Introduce a new --{,no-}overlay option, which allows using 'git
checkout' in non-overlay mode, thus removing files from the working
tree if they do not exist in <tree-ish> but match <pathspec>.
Note that 'git checkout -p <tree-ish> -- [<pathspec>]' already works
this way, so no changes are needed for the patch mode. We disallow
'git checkout --overlay -p' to avoid confusing users who would expect
to be able to force overlay mode in 'git checkout -p' this way.
Untracked files are not affected by this change, so 'git checkout
--no-overlay HEAD -- untracked' will not remove untracked from the
working tree. This is so e.g. 'git checkout --no-overlay HEAD -- dir/'
doesn't delete all untracked files in dir/, but rather just resets the
state of files that are known to git.
Suggested-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-01-08 21:52:24 +00:00
|
|
|
In the default overlay mode, `git checkout` never
|
|
|
|
removes files from the index or the working tree. When
|
|
|
|
specifying `--no-overlay`, files that appear in the index and
|
2019-03-29 10:38:56 +00:00
|
|
|
working tree, but not in `<tree-ish>` are removed, to make them
|
|
|
|
match `<tree-ish>` exactly.
|
checkout: introduce --{,no-}overlay option
Currently 'git checkout' is defined as an overlay operation, which
means that if in 'git checkout <tree-ish> -- [<pathspec>]' we have an
entry in the index that matches <pathspec>, but that doesn't exist in
<tree-ish>, that entry will not be removed from the index or the
working tree.
Introduce a new --{,no-}overlay option, which allows using 'git
checkout' in non-overlay mode, thus removing files from the working
tree if they do not exist in <tree-ish> but match <pathspec>.
Note that 'git checkout -p <tree-ish> -- [<pathspec>]' already works
this way, so no changes are needed for the patch mode. We disallow
'git checkout --overlay -p' to avoid confusing users who would expect
to be able to force overlay mode in 'git checkout -p' this way.
Untracked files are not affected by this change, so 'git checkout
--no-overlay HEAD -- untracked' will not remove untracked from the
working tree. This is so e.g. 'git checkout --no-overlay HEAD -- dir/'
doesn't delete all untracked files in dir/, but rather just resets the
state of files that are known to git.
Suggested-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-01-08 21:52:24 +00:00
|
|
|
|
2019-12-03 14:02:18 +00:00
|
|
|
--pathspec-from-file=<file>::
|
|
|
|
Pathspec is passed in `<file>` instead of commandline args. If
|
|
|
|
`<file>` is exactly `-` then standard input is used. Pathspec
|
|
|
|
elements are separated by LF or CR/LF. Pathspec elements can be
|
|
|
|
quoted as explained for the configuration variable `core.quotePath`
|
|
|
|
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
|
|
|
|
global `--literal-pathspecs`.
|
|
|
|
|
|
|
|
--pathspec-file-nul::
|
|
|
|
Only meaningful with `--pathspec-from-file`. Pathspec elements are
|
|
|
|
separated with NUL character and all other characters are taken
|
|
|
|
literally (including newlines and quotes).
|
|
|
|
|
2005-09-07 21:17:18 +00:00
|
|
|
<branch>::
|
2009-04-13 11:21:04 +00:00
|
|
|
Branch to checkout; if it refers to a branch (i.e., a name that,
|
|
|
|
when prepended with "refs/heads/", is a valid ref), then that
|
|
|
|
branch is checked out. Otherwise, if it refers to a valid
|
2019-03-29 10:38:56 +00:00
|
|
|
commit, your `HEAD` becomes "detached" and you are no longer on
|
2009-04-13 11:21:04 +00:00
|
|
|
any branch (see below for details).
|
2009-01-17 16:09:56 +00:00
|
|
|
+
|
2019-03-29 10:38:56 +00:00
|
|
|
You can use the `@{-N}` syntax to refer to the N-th last
|
2017-11-27 17:28:33 +00:00
|
|
|
branch/commit checked out using "git checkout" operation. You may
|
2019-03-29 10:38:56 +00:00
|
|
|
also specify `-` which is synonymous to `@{-1}`.
|
2010-06-01 15:16:42 +00:00
|
|
|
+
|
2019-03-29 10:38:56 +00:00
|
|
|
As a special case, you may use `A...B` as a shortcut for the
|
2010-06-01 15:16:42 +00:00
|
|
|
merge base of `A` and `B` if there is exactly one merge base. You can
|
|
|
|
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
|
2007-01-17 18:43:50 +00:00
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
<new-branch>::
|
2009-04-13 11:19:33 +00:00
|
|
|
Name for the new branch.
|
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
<start-point>::
|
2009-04-13 11:19:33 +00:00
|
|
|
The name of a commit at which to start the new branch; see
|
2019-03-29 10:38:56 +00:00
|
|
|
linkgit:git-branch[1] for details. Defaults to `HEAD`.
|
2019-04-27 12:02:22 +00:00
|
|
|
+
|
|
|
|
As a special case, you may use `"A...B"` as a shortcut for the
|
|
|
|
merge base of `A` and `B` if there is exactly one merge base. You can
|
|
|
|
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
|
2009-04-13 11:19:33 +00:00
|
|
|
|
|
|
|
<tree-ish>::
|
|
|
|
Tree to checkout from (when paths are given). If not specified,
|
|
|
|
the index will be used.
|
2020-10-07 07:56:16 +00:00
|
|
|
+
|
|
|
|
As a special case, you may use `"A...B"` as a shortcut for the
|
|
|
|
merge base of `A` and `B` if there is exactly one merge base. You can
|
|
|
|
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
|
2009-04-13 11:19:33 +00:00
|
|
|
|
2019-12-03 14:02:16 +00:00
|
|
|
\--::
|
|
|
|
Do not interpret any more arguments as options.
|
2009-04-13 11:19:33 +00:00
|
|
|
|
2019-12-03 14:02:16 +00:00
|
|
|
<pathspec>...::
|
|
|
|
Limits the paths affected by the operation.
|
|
|
|
+
|
|
|
|
For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
|
2007-01-17 18:43:50 +00:00
|
|
|
|
2011-02-08 10:32:49 +00:00
|
|
|
DETACHED HEAD
|
2007-01-17 18:43:50 +00:00
|
|
|
-------------
|
2019-03-29 10:38:56 +00:00
|
|
|
`HEAD` normally refers to a named branch (e.g. `master`). Meanwhile, each
|
2011-02-20 05:21:50 +00:00
|
|
|
branch refers to a specific commit. Let's look at a repo with three
|
2019-03-29 10:38:56 +00:00
|
|
|
commits, one of them tagged, and with branch `master` checked out:
|
2007-01-17 18:43:50 +00:00
|
|
|
|
2011-02-20 05:21:50 +00:00
|
|
|
------------
|
2018-10-22 20:45:42 +00:00
|
|
|
HEAD (refers to branch 'master')
|
|
|
|
|
|
|
|
|
v
|
2011-02-20 05:21:50 +00:00
|
|
|
a---b---c branch 'master' (refers to commit 'c')
|
|
|
|
^
|
|
|
|
|
|
|
|
|
tag 'v2.0' (refers to commit 'b')
|
|
|
|
------------
|
|
|
|
|
|
|
|
When a commit is created in this state, the branch is updated to refer to
|
2019-03-29 10:38:56 +00:00
|
|
|
the new commit. Specifically, 'git commit' creates a new commit `d`, whose
|
|
|
|
parent is commit `c`, and then updates branch `master` to refer to new
|
|
|
|
commit `d`. `HEAD` still refers to branch `master` and so indirectly now refers
|
|
|
|
to commit `d`:
|
2007-01-17 18:43:50 +00:00
|
|
|
|
|
|
|
------------
|
2011-02-20 05:21:50 +00:00
|
|
|
$ edit; git add; git commit
|
|
|
|
|
2018-10-22 20:45:42 +00:00
|
|
|
HEAD (refers to branch 'master')
|
|
|
|
|
|
|
|
|
v
|
2011-02-20 05:21:50 +00:00
|
|
|
a---b---c---d branch 'master' (refers to commit 'd')
|
|
|
|
^
|
|
|
|
|
|
|
|
|
tag 'v2.0' (refers to commit 'b')
|
2007-01-17 18:43:50 +00:00
|
|
|
------------
|
|
|
|
|
2011-02-20 05:21:50 +00:00
|
|
|
It is sometimes useful to be able to checkout a commit that is not at
|
|
|
|
the tip of any named branch, or even to create a new commit that is not
|
|
|
|
referenced by a named branch. Let's look at what happens when we
|
2019-03-29 10:38:56 +00:00
|
|
|
checkout commit `b` (here we show two ways this may be done):
|
2007-02-13 16:58:01 +00:00
|
|
|
|
|
|
|
------------
|
2011-02-20 05:21:50 +00:00
|
|
|
$ git checkout v2.0 # or
|
|
|
|
$ git checkout master^^
|
|
|
|
|
|
|
|
HEAD (refers to commit 'b')
|
|
|
|
|
|
|
|
|
v
|
|
|
|
a---b---c---d branch 'master' (refers to commit 'd')
|
|
|
|
^
|
|
|
|
|
|
|
|
|
tag 'v2.0' (refers to commit 'b')
|
|
|
|
------------
|
2007-01-17 18:43:50 +00:00
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
Notice that regardless of which checkout command we use, `HEAD` now refers
|
|
|
|
directly to commit `b`. This is known as being in detached `HEAD` state.
|
|
|
|
It means simply that `HEAD` refers to a specific commit, as opposed to
|
2011-02-20 05:21:50 +00:00
|
|
|
referring to a named branch. Let's see what happens when we create a commit:
|
2007-02-13 16:58:01 +00:00
|
|
|
|
|
|
|
------------
|
2011-02-20 05:21:50 +00:00
|
|
|
$ edit; git add; git commit
|
|
|
|
|
|
|
|
HEAD (refers to commit 'e')
|
|
|
|
|
|
|
|
|
v
|
|
|
|
e
|
|
|
|
/
|
|
|
|
a---b---c---d branch 'master' (refers to commit 'd')
|
|
|
|
^
|
|
|
|
|
|
|
|
|
tag 'v2.0' (refers to commit 'b')
|
2007-02-13 16:58:01 +00:00
|
|
|
------------
|
2005-08-23 08:49:47 +00:00
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
There is now a new commit `e`, but it is referenced only by `HEAD`. We can
|
2011-02-20 05:21:50 +00:00
|
|
|
of course add yet another commit in this state:
|
2005-08-23 08:49:47 +00:00
|
|
|
|
2011-02-20 05:21:50 +00:00
|
|
|
------------
|
|
|
|
$ edit; git add; git commit
|
|
|
|
|
|
|
|
HEAD (refers to commit 'f')
|
|
|
|
|
|
|
|
|
v
|
|
|
|
e---f
|
|
|
|
/
|
|
|
|
a---b---c---d branch 'master' (refers to commit 'd')
|
|
|
|
^
|
|
|
|
|
|
|
|
|
tag 'v2.0' (refers to commit 'b')
|
|
|
|
------------
|
|
|
|
|
2013-01-21 19:17:53 +00:00
|
|
|
In fact, we can perform all the normal Git operations. But, let's look
|
2019-03-29 10:38:56 +00:00
|
|
|
at what happens when we then checkout `master`:
|
2011-02-20 05:21:50 +00:00
|
|
|
|
|
|
|
------------
|
|
|
|
$ git checkout master
|
|
|
|
|
2018-10-22 20:45:42 +00:00
|
|
|
HEAD (refers to branch 'master')
|
2011-02-20 05:21:50 +00:00
|
|
|
e---f |
|
|
|
|
/ v
|
|
|
|
a---b---c---d branch 'master' (refers to commit 'd')
|
|
|
|
^
|
|
|
|
|
|
|
|
|
tag 'v2.0' (refers to commit 'b')
|
|
|
|
------------
|
|
|
|
|
|
|
|
It is important to realize that at this point nothing refers to commit
|
2019-03-29 10:38:56 +00:00
|
|
|
`f`. Eventually commit `f` (and by extension commit `e`) will be deleted
|
2013-01-21 19:17:53 +00:00
|
|
|
by the routine Git garbage collection process, unless we create a reference
|
2019-03-29 10:38:56 +00:00
|
|
|
before that happens. If we have not yet moved away from commit `f`,
|
2011-02-20 05:21:50 +00:00
|
|
|
any of these will create a reference to it:
|
|
|
|
|
|
|
|
------------
|
|
|
|
$ git checkout -b foo <1>
|
|
|
|
$ git branch foo <2>
|
|
|
|
$ git tag foo <3>
|
|
|
|
------------
|
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
<1> creates a new branch `foo`, which refers to commit `f`, and then
|
|
|
|
updates `HEAD` to refer to branch `foo`. In other words, we'll no longer
|
|
|
|
be in detached `HEAD` state after this command.
|
2011-02-20 05:21:50 +00:00
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
<2> similarly creates a new branch `foo`, which refers to commit `f`,
|
|
|
|
but leaves `HEAD` detached.
|
2011-02-20 05:21:50 +00:00
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
<3> creates a new tag `foo`, which refers to commit `f`,
|
|
|
|
leaving `HEAD` detached.
|
2011-02-20 05:21:50 +00:00
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
If we have moved away from commit `f`, then we must first recover its object
|
2011-02-20 05:21:50 +00:00
|
|
|
name (typically by using git reflog), and then we can create a reference to
|
2019-03-29 10:38:56 +00:00
|
|
|
it. For example, to see the last two commits to which `HEAD` referred, we
|
2011-02-20 05:21:50 +00:00
|
|
|
can use either of these commands:
|
|
|
|
|
|
|
|
------------
|
|
|
|
$ git reflog -2 HEAD # or
|
|
|
|
$ git log -g -2 HEAD
|
|
|
|
------------
|
2005-10-18 08:29:27 +00:00
|
|
|
|
2016-09-07 11:19:40 +00:00
|
|
|
ARGUMENT DISAMBIGUATION
|
|
|
|
-----------------------
|
|
|
|
|
2019-03-29 10:38:56 +00:00
|
|
|
When there is only one argument given and it is not `--` (e.g. `git
|
|
|
|
checkout abc`), and when the argument is both a valid `<tree-ish>`
|
|
|
|
(e.g. a branch `abc` exists) and a valid `<pathspec>` (e.g. a file
|
2016-09-07 11:19:40 +00:00
|
|
|
or a directory whose name is "abc" exists), Git would usually ask
|
|
|
|
you to disambiguate. Because checking out a branch is so common an
|
2019-03-29 10:38:56 +00:00
|
|
|
operation, however, `git checkout abc` takes "abc" as a `<tree-ish>`
|
2016-09-07 11:19:40 +00:00
|
|
|
in such a situation. Use `git checkout -- <pathspec>` if you want
|
|
|
|
to checkout these paths out of the index.
|
|
|
|
|
2006-01-12 22:04:36 +00:00
|
|
|
EXAMPLES
|
|
|
|
--------
|
2005-10-18 08:29:27 +00:00
|
|
|
|
2006-01-12 22:04:36 +00:00
|
|
|
. The following sequence checks out the `master` branch, reverts
|
2019-03-29 10:38:56 +00:00
|
|
|
the `Makefile` to two revisions back, deletes `hello.c` by
|
2019-01-22 20:16:35 +00:00
|
|
|
mistake, and gets it back from the index.
|
2006-01-12 22:04:36 +00:00
|
|
|
+
|
2005-10-18 08:29:27 +00:00
|
|
|
------------
|
2006-04-28 13:15:05 +00:00
|
|
|
$ git checkout master <1>
|
|
|
|
$ git checkout master~2 Makefile <2>
|
2005-10-18 08:29:27 +00:00
|
|
|
$ rm -f hello.c
|
2006-04-28 13:15:05 +00:00
|
|
|
$ git checkout hello.c <3>
|
|
|
|
------------
|
|
|
|
+
|
2005-12-13 07:24:06 +00:00
|
|
|
<1> switch branch
|
2009-03-10 15:06:30 +00:00
|
|
|
<2> take a file out of another commit
|
2019-03-29 10:38:56 +00:00
|
|
|
<3> restore `hello.c` from the index
|
2006-01-12 22:04:36 +00:00
|
|
|
+
|
2012-09-04 15:28:27 +00:00
|
|
|
If you want to check out _all_ C source files out of the index,
|
|
|
|
you can say
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git checkout -- '*.c'
|
|
|
|
------------
|
|
|
|
+
|
|
|
|
Note the quotes around `*.c`. The file `hello.c` will also be
|
|
|
|
checked out, even though it is no longer in the working tree,
|
|
|
|
because the file globbing is used to match entries in the index
|
|
|
|
(not in the working tree by the shell).
|
|
|
|
+
|
2006-04-28 13:15:05 +00:00
|
|
|
If you have an unfortunate branch that is named `hello.c`, this
|
|
|
|
step would be confused as an instruction to switch to that branch.
|
|
|
|
You should instead write:
|
2006-01-12 22:04:36 +00:00
|
|
|
+
|
2005-10-18 08:29:27 +00:00
|
|
|
------------
|
|
|
|
$ git checkout -- hello.c
|
|
|
|
------------
|
|
|
|
|
2009-03-10 15:06:30 +00:00
|
|
|
. After working in the wrong branch, switching to the correct
|
2019-01-22 20:16:35 +00:00
|
|
|
branch would be done using:
|
2006-01-12 22:04:36 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git checkout mytopic
|
|
|
|
------------
|
|
|
|
+
|
2019-03-29 10:38:56 +00:00
|
|
|
However, your "wrong" branch and correct `mytopic` branch may
|
2009-03-10 15:06:30 +00:00
|
|
|
differ in files that you have modified locally, in which case
|
2006-01-12 22:04:36 +00:00
|
|
|
the above checkout would fail like this:
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git checkout mytopic
|
2010-07-09 20:27:48 +00:00
|
|
|
error: You have local changes to 'frotz'; not switching branches.
|
2006-01-12 22:04:36 +00:00
|
|
|
------------
|
|
|
|
+
|
|
|
|
You can give the `-m` flag to the command, which would try a
|
|
|
|
three-way merge:
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git checkout -m mytopic
|
|
|
|
Auto-merging frotz
|
|
|
|
------------
|
|
|
|
+
|
|
|
|
After this three-way merge, the local modifications are _not_
|
|
|
|
registered in your index file, so `git diff` would show you what
|
|
|
|
changes you made since the tip of the new branch.
|
|
|
|
|
|
|
|
. When a merge conflict happens during switching branches with
|
2019-01-22 20:16:35 +00:00
|
|
|
the `-m` option, you would see something like this:
|
2006-01-12 22:04:36 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git checkout -m mytopic
|
|
|
|
Auto-merging frotz
|
|
|
|
ERROR: Merge conflict in frotz
|
|
|
|
fatal: merge program failed
|
|
|
|
------------
|
|
|
|
+
|
|
|
|
At this point, `git diff` shows the changes cleanly merged as in
|
|
|
|
the previous example, as well as the changes in the conflicted
|
|
|
|
files. Edit and resolve the conflict and mark it resolved with
|
2007-02-17 09:43:42 +00:00
|
|
|
`git add` as usual:
|
2006-01-12 22:04:36 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ edit frotz
|
2007-02-17 09:43:42 +00:00
|
|
|
$ git add frotz
|
2006-01-12 22:04:36 +00:00
|
|
|
------------
|
|
|
|
|
2019-03-29 10:39:05 +00:00
|
|
|
SEE ALSO
|
|
|
|
--------
|
2019-04-25 09:45:45 +00:00
|
|
|
linkgit:git-switch[1],
|
|
|
|
linkgit:git-restore[1]
|
2019-03-29 10:39:05 +00:00
|
|
|
|
2005-08-23 08:49:47 +00:00
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|