diff options
| author | Philippe Blain <levraiphilippeblain@gmail.com> | 2023-05-22 19:28:57 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-05-23 17:21:46 +0900 |
| commit | 6ec5f46071f793dbfa0915212b5708e2ce017053 (patch) | |
| tree | 1bfe7680e7c37aae97bb1109b6e4e303e6167254 /Documentation/revisions.txt | |
| parent | bc11bac3291c4cbeb4fb475c4fdc6fe3b22ba12e (diff) | |
| download | git-6ec5f46071f793dbfa0915212b5708e2ce017053.tar.gz | |
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>
Diffstat (limited to 'Documentation/revisions.txt')
| -rw-r--r-- | Documentation/revisions.txt | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt index ab5b8cf880..b34f981622 100644 --- a/Documentation/revisions.txt +++ b/Documentation/revisions.txt @@ -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 |