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>
This commit is contained in:
parent
57103dbf70
commit
661c3e9bc0
@ -358,7 +358,7 @@ OPTIONS
|
|||||||
--no-checkout::
|
--no-checkout::
|
||||||
+
|
+
|
||||||
Do not checkout the new working tree at each iteration of the bisection
|
Do not checkout the new working tree at each iteration of the bisection
|
||||||
process. Instead just update a special reference named 'BISECT_HEAD' to make
|
process. Instead just update a special reference named `BISECT_HEAD` to make
|
||||||
it point to the commit that should be tested.
|
it point to the commit that should be tested.
|
||||||
+
|
+
|
||||||
This option may be useful when the test you would perform in each step
|
This option may be useful when the test you would perform in each step
|
||||||
|
@ -39,10 +39,10 @@ named commit). With `--merged`, only branches merged into the named
|
|||||||
commit (i.e. the branches whose tip commits are reachable from the named
|
commit (i.e. the branches whose tip commits are reachable from the named
|
||||||
commit) will be listed. With `--no-merged` only branches not merged into
|
commit) will be listed. With `--no-merged` only branches not merged into
|
||||||
the named commit will be listed. If the <commit> argument is missing it
|
the named commit will be listed. If the <commit> argument is missing it
|
||||||
defaults to 'HEAD' (i.e. the tip of the current branch).
|
defaults to `HEAD` (i.e. the tip of the current branch).
|
||||||
|
|
||||||
The command's second form creates a new branch head named <branchname>
|
The command's second form creates a new branch head named <branchname>
|
||||||
which points to the current 'HEAD', or <start-point> if given.
|
which points to the current `HEAD`, or <start-point> if given.
|
||||||
|
|
||||||
Note that this will create the new branch, but it will not switch the
|
Note that this will create the new branch, but it will not switch the
|
||||||
working tree to it; use "git checkout <newbranch>" to switch to the
|
working tree to it; use "git checkout <newbranch>" to switch to the
|
||||||
|
@ -74,10 +74,10 @@ OPTIONS
|
|||||||
akin to the way 'git clone' uses 'origin' by default.
|
akin to the way 'git clone' uses 'origin' by default.
|
||||||
|
|
||||||
-o <branch-for-HEAD>::
|
-o <branch-for-HEAD>::
|
||||||
When no remote is specified (via -r) the 'HEAD' branch
|
When no remote is specified (via -r) the `HEAD` branch
|
||||||
from CVS is imported to the 'origin' branch within the Git
|
from CVS is imported to the 'origin' branch within the Git
|
||||||
repository, as 'HEAD' already has a special meaning for Git.
|
repository, as `HEAD` already has a special meaning for Git.
|
||||||
When a remote is specified the 'HEAD' branch is named
|
When a remote is specified the `HEAD` branch is named
|
||||||
remotes/<remote>/master mirroring 'git clone' behaviour.
|
remotes/<remote>/master mirroring 'git clone' behaviour.
|
||||||
Use this option if you want to import into a different
|
Use this option if you want to import into a different
|
||||||
branch.
|
branch.
|
||||||
|
@ -332,7 +332,7 @@ To get a checkout with the Eclipse CVS client:
|
|||||||
3. Browse the 'modules' available. It will give you a list of the heads in
|
3. Browse the 'modules' available. It will give you a list of the heads in
|
||||||
the repository. You will not be able to browse the tree from there. Only
|
the repository. You will not be able to browse the tree from there. Only
|
||||||
the heads.
|
the heads.
|
||||||
4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the
|
4. Pick `HEAD` when it asks what branch/tag to check out. Untick the
|
||||||
"launch commit wizard" to avoid committing the .project file.
|
"launch commit wizard" to avoid committing the .project file.
|
||||||
|
|
||||||
Protocol notes: If you are using anonymous access via pserver, just select that.
|
Protocol notes: If you are using anonymous access via pserver, just select that.
|
||||||
|
@ -296,7 +296,7 @@ they correspond to these IP addresses.
|
|||||||
selectively enable/disable services per repository::
|
selectively enable/disable services per repository::
|
||||||
To enable 'git archive --remote' and disable 'git fetch' against
|
To enable 'git archive --remote' and disable 'git fetch' against
|
||||||
a repository, have the following in the configuration file in the
|
a repository, have the following in the configuration file in the
|
||||||
repository (that is the file 'config' next to 'HEAD', 'refs' and
|
repository (that is the file 'config' next to `HEAD`, 'refs' and
|
||||||
'objects').
|
'objects').
|
||||||
+
|
+
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
|
@ -35,7 +35,7 @@ blame::
|
|||||||
|
|
||||||
browser::
|
browser::
|
||||||
Start a tree browser showing all files in the specified
|
Start a tree browser showing all files in the specified
|
||||||
commit (or 'HEAD' by default). Files selected through the
|
commit (or `HEAD` by default). Files selected through the
|
||||||
browser are opened in the blame viewer.
|
browser are opened in the blame viewer.
|
||||||
|
|
||||||
citool::
|
citool::
|
||||||
|
@ -27,9 +27,9 @@ in the current working directory. Note that:
|
|||||||
taken as relative to the current working directory. E.g. when you are
|
taken as relative to the current working directory. E.g. when you are
|
||||||
in a directory 'sub' that has a directory 'dir', you can run 'git
|
in a directory 'sub' that has a directory 'dir', you can run 'git
|
||||||
ls-tree -r HEAD dir' to list the contents of the tree (that is
|
ls-tree -r HEAD dir' to list the contents of the tree (that is
|
||||||
'sub/dir' in 'HEAD'). You don't want to give a tree that is not at the
|
'sub/dir' in `HEAD`). You don't want to give a tree that is not at the
|
||||||
root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that
|
root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that
|
||||||
would result in asking for 'sub/sub/dir' in the 'HEAD' commit.
|
would result in asking for 'sub/sub/dir' in the `HEAD` commit.
|
||||||
However, the current working directory can be ignored by passing
|
However, the current working directory can be ignored by passing
|
||||||
--full-tree option.
|
--full-tree option.
|
||||||
|
|
||||||
|
@ -275,7 +275,7 @@ These options can be used to modify 'git p4 submit' behavior.
|
|||||||
--origin <commit>::
|
--origin <commit>::
|
||||||
Upstream location from which commits are identified to submit to
|
Upstream location from which commits are identified to submit to
|
||||||
p4. By default, this is the most recent p4 commit reachable
|
p4. By default, this is the most recent p4 commit reachable
|
||||||
from 'HEAD'.
|
from `HEAD`.
|
||||||
|
|
||||||
-M::
|
-M::
|
||||||
Detect renames. See linkgit:git-diff[1]. Renames will be
|
Detect renames. See linkgit:git-diff[1]. Renames will be
|
||||||
|
@ -167,7 +167,7 @@ This option is only applicable when listing tags without annotation lines.
|
|||||||
|
|
||||||
--[no-]merged [<commit>]::
|
--[no-]merged [<commit>]::
|
||||||
Only list tags whose tips are reachable, or not reachable
|
Only list tags whose tips are reachable, or not reachable
|
||||||
if `--no-merged` is used, from the specified commit ('HEAD'
|
if `--no-merged` is used, from the specified commit (`HEAD`
|
||||||
if not specified).
|
if not specified).
|
||||||
|
|
||||||
CONFIGURATION
|
CONFIGURATION
|
||||||
|
@ -298,7 +298,7 @@ Supported if the helper has the "fetch" capability.
|
|||||||
is followed by a blank line). For example, the following would
|
is followed by a blank line). For example, the following would
|
||||||
be two batches of 'push', the first asking the remote-helper
|
be two batches of 'push', the first asking the remote-helper
|
||||||
to push the local ref 'master' to the remote ref 'master' and
|
to push the local ref 'master' to the remote ref 'master' and
|
||||||
the local 'HEAD' to the remote 'branch', and the second
|
the local `HEAD` to the remote 'branch', and the second
|
||||||
asking to push ref 'foo' to ref 'bar' (forced update requested
|
asking to push ref 'foo' to ref 'bar' (forced update requested
|
||||||
by the '+').
|
by the '+').
|
||||||
+
|
+
|
||||||
|
@ -28,8 +28,8 @@ blobs contained in a commit.
|
|||||||
first match in the following rules:
|
first match in the following rules:
|
||||||
|
|
||||||
. If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
|
. If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
|
||||||
useful only for 'HEAD', 'FETCH_HEAD', 'ORIG_HEAD', 'MERGE_HEAD'
|
useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`
|
||||||
and 'CHERRY_PICK_HEAD');
|
and `CHERRY_PICK_HEAD`);
|
||||||
|
|
||||||
. otherwise, 'refs/<refname>' if it exists;
|
. otherwise, 'refs/<refname>' if it exists;
|
||||||
|
|
||||||
@ -41,16 +41,16 @@ blobs contained in a commit.
|
|||||||
|
|
||||||
. otherwise, 'refs/remotes/<refname>/HEAD' if it exists.
|
. otherwise, 'refs/remotes/<refname>/HEAD' if it exists.
|
||||||
+
|
+
|
||||||
'HEAD' names the commit on which you based the changes in the working tree.
|
`HEAD` names the commit on which you based the changes in the working tree.
|
||||||
'FETCH_HEAD' records the branch which you fetched from a remote repository
|
`FETCH_HEAD` records the branch which you fetched from a remote repository
|
||||||
with your last `git fetch` invocation.
|
with your last `git fetch` invocation.
|
||||||
'ORIG_HEAD' is created by commands that move your 'HEAD' in a drastic
|
`ORIG_HEAD` is created by commands that move your `HEAD` in a drastic
|
||||||
way, to record the position of the 'HEAD' before their operation, so that
|
way, to record the position of the `HEAD` before their operation, so that
|
||||||
you can easily change the tip of the branch back to the state before you ran
|
you can easily change the tip of the branch back to the state before you ran
|
||||||
them.
|
them.
|
||||||
'MERGE_HEAD' records the commit(s) which you are merging into your branch
|
`MERGE_HEAD` records the commit(s) which you are merging into your branch
|
||||||
when you run `git merge`.
|
when you run `git merge`.
|
||||||
'CHERRY_PICK_HEAD' records the commit which you are cherry-picking
|
`CHERRY_PICK_HEAD` records the commit which you are cherry-picking
|
||||||
when you run `git cherry-pick`.
|
when you run `git cherry-pick`.
|
||||||
+
|
+
|
||||||
Note that any of the 'refs/*' cases above may come either from
|
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
|
|||||||
some output processing may assume ref names in UTF-8.
|
some output processing may assume ref names in UTF-8.
|
||||||
|
|
||||||
'@'::
|
'@'::
|
||||||
'@' alone is a shortcut for 'HEAD'.
|
'@' alone is a shortcut for `HEAD`.
|
||||||
|
|
||||||
'<refname>@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
|
'<refname>@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
|
||||||
A ref followed by the suffix '@' with a date specification
|
A ref followed by the suffix '@' with a date specification
|
||||||
@ -101,7 +101,7 @@ some output processing may assume ref names in UTF-8.
|
|||||||
'<branchname>@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
|
'<branchname>@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
|
||||||
The suffix '@\{push}' reports the branch "where we would push to" if
|
The suffix '@\{push}' reports the branch "where we would push to" if
|
||||||
`git push` were run while `branchname` was checked out (or the current
|
`git push` were run while `branchname` was checked out (or the current
|
||||||
'HEAD' if no branchname is specified). Since our push destination is
|
`HEAD` if no branchname is specified). Since our push destination is
|
||||||
in a remote repository, of course, we report the local tracking branch
|
in a remote repository, of course, we report the local tracking branch
|
||||||
that corresponds to that branch (i.e., something in 'refs/remotes/').
|
that corresponds to that branch (i.e., something in 'refs/remotes/').
|
||||||
+
|
+
|
||||||
@ -283,12 +283,12 @@ To summarize:
|
|||||||
'<rev1>..<rev2>'::
|
'<rev1>..<rev2>'::
|
||||||
Include commits that are reachable from <rev2> but exclude
|
Include commits that are reachable from <rev2> but exclude
|
||||||
those that are reachable from <rev1>. When either <rev1> or
|
those that are reachable from <rev1>. When either <rev1> or
|
||||||
<rev2> is omitted, it defaults to 'HEAD'.
|
<rev2> is omitted, it defaults to `HEAD`.
|
||||||
|
|
||||||
'<rev1>\...<rev2>'::
|
'<rev1>\...<rev2>'::
|
||||||
Include commits that are reachable from either <rev1> or
|
Include commits that are reachable from either <rev1> or
|
||||||
<rev2> but exclude those that are reachable from both. When
|
<rev2> but exclude those that are reachable from both. When
|
||||||
either <rev1> or <rev2> is omitted, it defaults to 'HEAD'.
|
either <rev1> or <rev2> is omitted, it defaults to `HEAD`.
|
||||||
|
|
||||||
'<rev>{caret}@', e.g. 'HEAD{caret}@'::
|
'<rev>{caret}@', e.g. 'HEAD{caret}@'::
|
||||||
A suffix '{caret}' followed by an at sign is the same as listing
|
A suffix '{caret}' followed by an at sign is the same as listing
|
||||||
|
Loading…
Reference in New Issue
Block a user