diff options
| author | J. Bruce Fields <bfields@citi.umich.edu> | 2007-04-16 00:37:14 -0400 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2007-04-16 01:10:29 -0700 |
| commit | 72a76c955bcbe6370db7dc34b962851de189e650 (patch) | |
| tree | ff12149c6036ea44b58ec09f9c4a69c7c6b55839 | |
| parent | 4f752407964a81cf2ba5750343a7f0daf54c19b8 (diff) | |
| download | git-72a76c955bcbe6370db7dc34b962851de189e650.tar.gz | |
user-manual: detached HEAD
Add a brief mention of detached HEADs and .git/HEAD.
Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
Signed-off-by: Junio C Hamano <junkio@cox.net>
| -rw-r--r-- | Documentation/user-manual.txt | 44 |
1 files changed, 42 insertions, 2 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 49e936fa10..bff072fb90 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -495,8 +495,48 @@ git checkout -b <new> <start-point>:: create a new branch <new> referencing <start-point>, and check it out. -It is also useful to know that the special symbol "HEAD" can always -be used to refer to the current branch. +The special symbol "HEAD" can always be used to refer to the current +branch. In fact, git uses a file named "HEAD" in the .git directory to +remember which branch is current: + +------------------------------------------------ +$ cat .git/HEAD +ref: refs/heads/master +------------------------------------------------ + +Examining an old version without creating a new branch +------------------------------------------------------ + +The git-checkout command normally expects a branch head, but will also +accept an arbitrary commit; for example, you can check out the commit +referenced by a tag: + +------------------------------------------------ +$ git checkout v2.6.17 +Note: moving to "v2.6.17" which isn't a local branch +If you want to create a new branch from this checkout, you may do so +(now or later) by using -b with the checkout command again. Example: + git checkout -b <new_branch_name> +HEAD is now at 427abfa... Linux v2.6.17 +------------------------------------------------ + +The HEAD then refers to the SHA1 of the commit instead of to a branch, +and git branch shows that you are no longer on a branch: + +------------------------------------------------ +$ cat .git/HEAD +427abfa28afedffadfca9dd8b067eb6d36bac53f +git branch +* (no branch) + master +------------------------------------------------ + +In this case we say that the HEAD is "detached". + +This can be an easy way to check out a particular version without having +to make up a name for a new branch. However, keep in mind that when you +switch away from the (for example, by checking out something else), you +can lose track of what the HEAD used to point to. Examining branches from a remote repository ------------------------------------------- |