admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: git-checkout: deduplicate --detach explanation

Browse Source 
From user feedback: several users say they don't understand the use case
for `--detach`. It's probably not realistic to explain the use case for
detached HEAD state here, but we can improve the situation.

Explain how `git checkout --detach` is different from
`git checkout <branch>` instead of copying over the description from
`git checkout <branch>`, since `git checkout <branch>` will be a
familiar command to many readers.

Signed-off-by: Julia Evans <julia@jvns.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Julia Evans
2025-09-10 19:14:27 +00:00
committed by Junio C Hamano
parent 042d6f3402
commit 0dd71f607c
1 changed files with 3 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/git-checkout.adoc
View File

@@ -66,16 +66,9 @@ uncommitted changes.
`git checkout --detach [<branch>]`:: `git checkout --detach [<branch>]`::
`git checkout [--detach] <commit>`:: `git checkout [--detach] <commit>`::
Prepare to work on top of _<commit>_, by detaching `HEAD` at it The same as `git checkout <branch>`, except that instead of pointing
(see "DETACHED HEAD" section), and updating the index and the `HEAD` at the branch, it points `HEAD` at the commit ID.
files in the working tree. Local modifications to the files See the "DETACHED HEAD" section below for more.
in the working tree are kept, so that the resulting working
tree will be the state recorded in the commit plus the local
modifications.
+
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`).
+ +
Omitting _<branch>_ detaches `HEAD` at the tip of the current branch. Omitting _<branch>_ detaches `HEAD` at the tip of the current branch.