X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-checkout.txt;h=918d8ee720a573f91ec6efa654da5c2cdc05d7b0;hb=f7b47b273ed2c9e9b298c4f5dd02884b46dfbced;hp=4ea2b315d29957a4287d697bf50ab9cfea3a7ef1;hpb=84a978f11870824dae45c7d0fa612a10f64b3fff;p=git.git diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 4ea2b315d..918d8ee72 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -8,7 +8,7 @@ git-checkout - Checkout and switch to a branch SYNOPSIS -------- [verse] -'git-checkout' [-f] [-b [-l]] [-m] [] +'git-checkout' [-q] [-f] [[--track | --no-track] -b [-l]] [-m] [] 'git-checkout' [] ... DESCRIPTION @@ -18,13 +18,14 @@ When are not given, this command switches branches by updating the index and working tree to reflect the specified branch, , and updating HEAD to be or, if specified, . Using -b will cause to -be created. +be created; in this case you can use the --track or --no-track +options, which will be passed to `git branch`. When are given, this command does *not* switch branches. It updates the named paths in the working tree from -the index file (i.e. it runs `git-checkout-index -f -u`), or a -named commit. In -this case, `-f` and `-b` options are meaningless and giving +the index file (i.e. it runs `git-checkout-index -f -u`), or +from a named commit. In +this case, the `-f` and `-b` options are meaningless and giving either of them results in an error. argument can be used to specify a specific tree-ish (i.e. commit, tag or tree) to update the index for the given paths before updating the @@ -33,8 +34,12 @@ working tree. OPTIONS ------- +-q:: + Quiet, supress feedback messages. + -f:: - Force a re-read of everything. + Proceed even if the index or the working tree differs + from HEAD. This is used to throw away local changes. -b:: Create a new branch named and start it at @@ -42,6 +47,20 @@ OPTIONS by gitlink:git-check-ref-format[1]. Some of these checks may restrict the characters allowed in a branch name. +--track:: + When -b is given and a branch is created off a remote branch, + set up configuration so that git-pull will automatically + retrieve data from the remote branch. Set the + branch.autosetupmerge configuration variable to true if you + want git-checkout and git-branch to always behave as if + '--track' were given. + +--no-track:: + When -b is given and a branch is created off a remote branch, + set up configuration so that git-pull will not retrieve data + from the remote branch, ignoring the branch.autosetupmerge + configuration variable. + -l:: Create the new branch's ref log. This activates recording of all changes to made the branch ref, enabling use of date @@ -58,7 +77,8 @@ OPTIONS + When a merge conflict happens, the index entries for conflicting paths are left unmerged, and you need to resolve the conflicts -and mark the resolved paths with `git update-index`. +and mark the resolved paths with `git add` (or `git rm` if the merge +should result in deletion of the path). :: Name for the new branch. @@ -100,22 +120,12 @@ by any branch (which is natural --- you are not on any branch). What this means is that you can discard your temporary commits and merges by switching back to an existing branch (e.g. `git checkout master`), and a later `git prune` or `git gc` would -garbage-collect them. - -The command would refuse to switch back to make sure that you do -not discard your temporary state by mistake when your detached -HEAD is not pointed at by any existing ref. If you did want to -save your state (e.g. "I was interested in the fifth commit from -the top of 'master' branch", or "I made two commits to fix minor -bugs while on a detached HEAD" -- and if you do not want to lose -these facts), you can create a new branch and switch to it with -`git checkout -b newbranch` so that you can keep building on -that state, or tag it first so that you can come back to it -later and switch to the branch you wanted to switch to with `git -tag that_state; git checkout master`. On the other hand, if you -did want to discard the temporary state, you can give `-f` -option (e.g. `git checkout -f master`) to override this -behaviour. +garbage-collect them. If you did this by mistake, you can ask +the reflog for HEAD where you were, e.g. + +------------ +$ git log -g -2 HEAD +------------ EXAMPLES @@ -186,11 +196,11 @@ 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 -`git update-index` as usual: +`git add` as usual: + ------------ $ edit frotz -$ git update-index frotz +$ git add frotz ------------