revisions.txt: document more special refs
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>
Philippe Blain committed
May 22, 2023 at 19:28 UTC
6ec5f46071f793dbfa0915212b5708e2ce017053
1 file changed
+11
-2
Documentation/revisions.txt
+11
-2
@@ -32,8 +32,8 @@ characters and to avoid word splitting.
32
first match in the following rules:
33
+
34
. If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
35
- useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`
36
- and `CHERRY_PICK_HEAD`);
35
+ useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`,
36
+ `REBASE_HEAD`, `REVERT_HEAD`, `CHERRY_PICK_HEAD` and `BISECT_HEAD`);
37
38
. otherwise, 'refs/<refname>' if it exists;
39
@@ -59,9 +59,18 @@ characters and to avoid word splitting.
59
`MERGE_HEAD`:::
60
records the commit(s) which you are merging into your branch when you
61
run `git merge`.
62
+ `REBASE_HEAD`:::
63
+ during a rebase, records the commit at which the operation is
64
+ currently stopped, either because of conflicts or an `edit` command in
65
+ an interactive rebase.
66
+ `REVERT_HEAD`:::
67
+ records the commit which you are reverting when you run `git revert`.
68
`CHERRY_PICK_HEAD`:::
69
records the commit which you are cherry-picking when you run `git
70
cherry-pick`.
71
+ `BISECT_HEAD`:::
72
+ records the current commit to be tested when you run `git bisect
73
+ --no-checkout`.
74
75
+
76
Note that any of the 'refs/*' cases above may come either from