Skip to content

Commit 79f79e5

Browse files
committed
Merge branch 'jc/doc-most-refs-are-not-that-special' into maint-2.43
Doc updates. * jc/doc-most-refs-are-not-that-special: docs: MERGE_AUTOSTASH is not that special docs: AUTO_MERGE is not that special refs.h: HEAD is not that special git-bisect.txt: BISECT_HEAD is not that special git.txt: HEAD is not that special
2 parents 7b95c64 + bc62d27 commit 79f79e5

File tree

7 files changed

+10
-9
lines changed

7 files changed

+10
-9
lines changed

Documentation/git-bisect.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ OPTIONS
362362
--no-checkout::
363363
+
364364
Do not checkout the new working tree at each iteration of the bisection
365-
process. Instead just update a special reference named `BISECT_HEAD` to make
365+
process. Instead just update the reference named `BISECT_HEAD` to make
366366
it point to the commit that should be tested.
367367
+
368368
This option may be useful when the test you would perform in each step

Documentation/git-diff.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Just in case you are doing something exotic, it should be
103103
noted that all of the <commit> in the above description, except
104104
in the `--merge-base` case and in the last two forms that use `..`
105105
notations, can be any <tree>. A tree of interest is the one pointed to
106-
by the special ref `AUTO_MERGE`, which is written by the 'ort' merge
106+
by the ref named `AUTO_MERGE`, which is written by the 'ort' merge
107107
strategy upon hitting merge conflicts (see linkgit:git-merge[1]).
108108
Comparing the working tree with `AUTO_MERGE` shows changes you've made
109109
so far to resolve textual conflicts (see the examples below).

Documentation/git-merge.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ happens:
196196
can inspect the stages with `git ls-files -u`). The working
197197
tree files contain the result of the merge operation; i.e. 3-way
198198
merge results with familiar conflict markers `<<<` `===` `>>>`.
199-
5. A special ref `AUTO_MERGE` is written, pointing to a tree
199+
5. A ref named `AUTO_MERGE` is written, pointing to a tree
200200
corresponding to the current content of the working tree (including
201201
conflict markers for textual conflicts). Note that this ref is only
202202
written when the 'ort' merge strategy is used (the default).

Documentation/git.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1024,10 +1024,11 @@ When first created, objects are stored in individual files, but for
10241024
efficiency may later be compressed together into "pack files".
10251025

10261026
Named pointers called refs mark interesting points in history. A ref
1027-
may contain the SHA-1 name of an object or the name of another ref. Refs
1028-
with names beginning `ref/head/` contain the SHA-1 name of the most
1027+
may contain the SHA-1 name of an object or the name of another ref (the
1028+
latter is called a "symbolic ref").
1029+
Refs with names beginning `refs/head/` contain the SHA-1 name of the most
10291030
recent commit (or "head") of a branch under development. SHA-1 names of
1030-
tags of interest are stored under `ref/tags/`. A special ref named
1031+
tags of interest are stored under `refs/tags/`. A symbolic ref named
10311032
`HEAD` contains the name of the currently checked-out branch.
10321033

10331034
The index file is initialized with a list of all paths and, for each

Documentation/merge-options.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ endif::git-pull[]
191191
--autostash::
192192
--no-autostash::
193193
Automatically create a temporary stash entry before the operation
194-
begins, record it in the special ref `MERGE_AUTOSTASH`
194+
begins, record it in the ref `MERGE_AUTOSTASH`
195195
and apply it after the operation ends. This means
196196
that you can run the operation on a dirty worktree. However, use
197197
with care: the final stash application after a successful

Documentation/user-manual.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1344,7 +1344,7 @@ $ git diff --theirs file.txt # same as the above.
13441344
-------------------------------------------------
13451345

13461346
When using the 'ort' merge strategy (the default), before updating the working
1347-
tree with the result of the merge, Git writes a special ref named AUTO_MERGE
1347+
tree with the result of the merge, Git writes a ref named AUTO_MERGE
13481348
reflecting the state of the tree it is about to write. Conflicted paths with
13491349
textual conflicts that could not be automatically merged are written to this
13501350
tree with conflict markers, just as in the working tree. AUTO_MERGE can thus be

refs.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ struct worktree;
5656
* Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
5757
* directory and do not consist of all caps and underscores cannot be
5858
* resolved. The function returns NULL for such ref names.
59-
* Caps and underscores refers to the special refs, such as HEAD,
59+
* Caps and underscores refers to the pseudorefs, such as HEAD,
6060
* FETCH_HEAD and friends, that all live outside of the refs/ directory.
6161
*/
6262
#define RESOLVE_REF_READING 0x01

0 commit comments

Comments
 (0)