doc: typeset HEAD and variants as literal
This is an application of the newly added CodingGuidelines to HEAD and variants like FETCH_HEAD. It was obtained with: perl -pi -e "s/'([A-Z_]*HEAD)'/\`\$1\`/g" *.txt Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Matthieu Moy committed
Jun 28, 2016 at 13:40 UTC
661c3e9bc064564a492281364413dc805eaddf95
11 files changed
+26
-26
Documentation/git-bisect.txt
+1
-1
@@ -358,7 +358,7 @@ OPTIONS
358
--no-checkout::
359
+
360
Do not checkout the new working tree at each iteration of the bisection
361
-process. Instead just update a special reference named 'BISECT_HEAD' to make
361
+process. Instead just update a special reference named `BISECT_HEAD` to make
362
it point to the commit that should be tested.
363
+
364
This option may be useful when the test you would perform in each step
Documentation/git-branch.txt
+2
-2
@@ -39,10 +39,10 @@ named commit). With `--merged`, only branches merged into the named
39
commit (i.e. the branches whose tip commits are reachable from the named
40
commit) will be listed. With `--no-merged` only branches not merged into
41
the named commit will be listed. If the <commit> argument is missing it
42
-defaults to 'HEAD' (i.e. the tip of the current branch).
42
+defaults to `HEAD` (i.e. the tip of the current branch).
43
44
The command's second form creates a new branch head named <branchname>
45
-which points to the current 'HEAD', or <start-point> if given.
45
+which points to the current `HEAD`, or <start-point> if given.
46
47
Note that this will create the new branch, but it will not switch the
48
working tree to it; use "git checkout <newbranch>" to switch to the
Documentation/git-cvsimport.txt
+3
-3
@@ -74,10 +74,10 @@ OPTIONS
74
akin to the way 'git clone' uses 'origin' by default.
75
76
-o <branch-for-HEAD>::
77
- When no remote is specified (via -r) the 'HEAD' branch
77
+ When no remote is specified (via -r) the `HEAD` branch
78
from CVS is imported to the 'origin' branch within the Git
79
- repository, as 'HEAD' already has a special meaning for Git.
80
- When a remote is specified the 'HEAD' branch is named
79
+ repository, as `HEAD` already has a special meaning for Git.
80
+ When a remote is specified the `HEAD` branch is named
81
remotes/<remote>/master mirroring 'git clone' behaviour.
82
Use this option if you want to import into a different
83
branch.
Documentation/git-cvsserver.txt
+1
-1
@@ -332,7 +332,7 @@ To get a checkout with the Eclipse CVS client:
332
3. Browse the 'modules' available. It will give you a list of the heads in
333
the repository. You will not be able to browse the tree from there. Only
334
the heads.
335
-4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the
335
+4. Pick `HEAD` when it asks what branch/tag to check out. Untick the
336
"launch commit wizard" to avoid committing the .project file.
337
338
Protocol notes: If you are using anonymous access via pserver, just select that.
Documentation/git-daemon.txt
+1
-1
@@ -296,7 +296,7 @@ they correspond to these IP addresses.
296
selectively enable/disable services per repository::
297
To enable 'git archive --remote' and disable 'git fetch' against
298
a repository, have the following in the configuration file in the
299
- repository (that is the file 'config' next to 'HEAD', 'refs' and
299
+ repository (that is the file 'config' next to `HEAD`, 'refs' and
300
'objects').
301
+
302
----------------------------------------------------------------
Documentation/git-gui.txt
+1
-1
@@ -35,7 +35,7 @@ blame::
35
36
browser::
37
Start a tree browser showing all files in the specified
38
- commit (or 'HEAD' by default). Files selected through the
38
+ commit (or `HEAD` by default). Files selected through the
39
browser are opened in the blame viewer.
40
41
citool::
Documentation/git-ls-tree.txt
+2
-2
@@ -27,9 +27,9 @@ in the current working directory. Note that:
27
taken as relative to the current working directory. E.g. when you are
28
in a directory 'sub' that has a directory 'dir', you can run 'git
29
ls-tree -r HEAD dir' to list the contents of the tree (that is
30
- 'sub/dir' in 'HEAD'). You don't want to give a tree that is not at the
30
+ 'sub/dir' in `HEAD`). You don't want to give a tree that is not at the
31
root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that
32
- would result in asking for 'sub/sub/dir' in the 'HEAD' commit.
32
+ would result in asking for 'sub/sub/dir' in the `HEAD` commit.
33
However, the current working directory can be ignored by passing
34
--full-tree option.
35
Documentation/git-p4.txt
+1
-1
@@ -275,7 +275,7 @@ These options can be used to modify 'git p4 submit' behavior.
275
--origin <commit>::
276
Upstream location from which commits are identified to submit to
277
p4. By default, this is the most recent p4 commit reachable
278
- from 'HEAD'.
278
+ from `HEAD`.
279
280
-M::
281
Detect renames. See linkgit:git-diff[1]. Renames will be
Documentation/git-tag.txt
+1
-1
@@ -167,7 +167,7 @@ This option is only applicable when listing tags without annotation lines.
167
168
--[no-]merged [<commit>]::
169
Only list tags whose tips are reachable, or not reachable
170
- if `--no-merged` is used, from the specified commit ('HEAD'
170
+ if `--no-merged` is used, from the specified commit (`HEAD`
171
if not specified).
172
173
CONFIGURATION
Documentation/gitremote-helpers.txt
+1
-1
@@ -298,7 +298,7 @@ Supported if the helper has the "fetch" capability.
298
is followed by a blank line). For example, the following would
299
be two batches of 'push', the first asking the remote-helper
300
to push the local ref 'master' to the remote ref 'master' and
301
- the local 'HEAD' to the remote 'branch', and the second
301
+ the local `HEAD` to the remote 'branch', and the second
302
asking to push ref 'foo' to ref 'bar' (forced update requested
303
by the '+').
304
+
Documentation/revisions.txt
+12
-12
@@ -28,8 +28,8 @@ blobs contained in a commit.
28
first match in the following rules:
29
30
. If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
31
- useful only for 'HEAD', 'FETCH_HEAD', 'ORIG_HEAD', 'MERGE_HEAD'
32
- and 'CHERRY_PICK_HEAD');
31
+ useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`
32
+ and `CHERRY_PICK_HEAD`);
33
34
. otherwise, 'refs/<refname>' if it exists;
35
@@ -41,16 +41,16 @@ blobs contained in a commit.
41
42
. otherwise, 'refs/remotes/<refname>/HEAD' if it exists.
43
+
44
-'HEAD' names the commit on which you based the changes in the working tree.
45
-'FETCH_HEAD' records the branch which you fetched from a remote repository
44
+`HEAD` names the commit on which you based the changes in the working tree.
45
+`FETCH_HEAD` records the branch which you fetched from a remote repository
46
with your last `git fetch` invocation.
47
-'ORIG_HEAD' is created by commands that move your 'HEAD' in a drastic
48
-way, to record the position of the 'HEAD' before their operation, so that
47
+`ORIG_HEAD` is created by commands that move your `HEAD` in a drastic
48
+way, to record the position of the `HEAD` before their operation, so that
49
you can easily change the tip of the branch back to the state before you ran
50
them.
51
-'MERGE_HEAD' records the commit(s) which you are merging into your branch
51
+`MERGE_HEAD` records the commit(s) which you are merging into your branch
52
when you run `git merge`.
53
-'CHERRY_PICK_HEAD' records the commit which you are cherry-picking
53
+`CHERRY_PICK_HEAD` records the commit which you are cherry-picking
54
when you run `git cherry-pick`.
55
+
56
Note that any of the 'refs/*' cases above may come either from
@@ -59,7 +59,7 @@ While the ref name encoding is unspecified, UTF-8 is preferred as
59
some output processing may assume ref names in UTF-8.
60
61
'@'::
62
- '@' alone is a shortcut for 'HEAD'.
62
+ '@' alone is a shortcut for `HEAD`.
63
64
'<refname>@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
65
A ref followed by the suffix '@' with a date specification
@@ -101,7 +101,7 @@ some output processing may assume ref names in UTF-8.
101
'<branchname>@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
102
The suffix '@\{push}' reports the branch "where we would push to" if
103
`git push` were run while `branchname` was checked out (or the current
104
- 'HEAD' if no branchname is specified). Since our push destination is
104
+ `HEAD` if no branchname is specified). Since our push destination is
105
in a remote repository, of course, we report the local tracking branch
106
that corresponds to that branch (i.e., something in 'refs/remotes/').
107
+
@@ -283,12 +283,12 @@ To summarize:
283
'<rev1>..<rev2>'::
284
Include commits that are reachable from <rev2> but exclude
285
those that are reachable from <rev1>. When either <rev1> or
286
- <rev2> is omitted, it defaults to 'HEAD'.
286
+ <rev2> is omitted, it defaults to `HEAD`.
287
288
'<rev1>\...<rev2>'::
289
Include commits that are reachable from either <rev1> or
290
<rev2> but exclude those that are reachable from both. When
291
- either <rev1> or <rev2> is omitted, it defaults to 'HEAD'.
291
+ either <rev1> or <rev2> is omitted, it defaults to `HEAD`.
292
293
'<rev>{caret}@', e.g. 'HEAD{caret}@'::
294
A suffix '{caret}' followed by an at sign is the same as listing