development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-10-02 14:45:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

revisions.txt: document more special refs

Browse source 
Some special refs, namely HEAD, FETCH_HEAD, ORIG_HEAD, MERGE_HEAD and
CHERRY_PICK_HEAD, are mentioned and described in 'gitrevisions', but some
others, namely REBASE_HEAD, REVERT_HEAD, and BISECT_HEAD, are not.

Add a small description of these special refs.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Philippe Blain 2023-05-22 19:28:57 +00:00 committed by Junio C Hamano
parent bc11bac329
commit 6ec5f46071
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
Documentation/revisions.txt
View file

@ -32,8 +32,8 @@ characters and to avoid word splitting.
first match in the following rules:
+
. If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`
and `CHERRY_PICK_HEAD`);
useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`,
`REBASE_HEAD`, `REVERT_HEAD`, `CHERRY_PICK_HEAD` and `BISECT_HEAD`);
. otherwise, 'refs/<refname>' if it exists;
@ -59,9 +59,18 @@ characters and to avoid word splitting.
`MERGE_HEAD`:::
records the commit(s) which you are merging into your branch when you
run `git merge`.
`REBASE_HEAD`:::
during a rebase, records the commit at which the operation is
currently stopped, either because of conflicts or an `edit` command in
an interactive rebase.
`REVERT_HEAD`:::
records the commit which you are reverting when you run `git revert`.
`CHERRY_PICK_HEAD`:::
records the commit which you are cherry-picking when you run `git
cherry-pick`.
`BISECT_HEAD`:::
records the current commit to be tested when you run `git bisect
--no-checkout`.
+
Note that any of the 'refs/*' cases above may come either from