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>

diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index d9f960b509146f2d7556ddd621b5eec70af49a73..2bb9a577a2b4a4e95dcf950239c2ead8d424319f 100644 (file)
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -358,7 +358,7 @@ OPTIONS
 --no-checkout::
 +
 Do not checkout the new working tree at each iteration of the bisection
 --no-checkout::
 +
 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.
 +
 This option may be useful when the test you would perform in each step
 it point to the commit that should be tested.
 +
 This option may be useful when the test you would perform in each step

diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 123144fe8a266129714f2ace978c054e75c402c5..1fe73448f3f5a3ff48f939924156771cabfc1f77 100644 (file)
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -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) will be listed.  With `--no-merged` only branches not merged into
 the named commit will be listed.  If the <commit> argument is missing it
 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
 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
 working tree to it; use "git checkout <newbranch>" to switch to 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

diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index bbf1c2bb6c3a60b581ab4b0f765a48a8e18c9dbe..41207a24b09cd111a239f4959ab8f121a7459421 100644 (file)
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -74,10 +74,10 @@ OPTIONS
        akin to the way 'git clone' uses 'origin' by default.
 
 -o <branch-for-HEAD>::
        akin to the way 'git clone' uses 'origin' by default.
 
 -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.
-       When a remote is specified the 'HEAD' branch is named
+       repository, as `HEAD` already has a special meaning for Git.
+       When a remote is specified the `HEAD` branch is named

        remotes/<remote>/master mirroring 'git clone' behaviour.
        Use this option if you want to import into a different
        branch.
        remotes/<remote>/master mirroring 'git clone' behaviour.
        Use this option if you want to import into a different
        branch.

diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index a1a523405a37598f7c1e80df48d5b71e4ee48c91..a336ae5f6fd5587aa8f778d2378783d0fe2e6dc4 100644 (file)
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -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
    the repository. You will not be able to browse the tree from there. Only
    the heads.
 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 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.
 
 Protocol notes: If you are using anonymous access via pserver, just select that.
    "launch commit wizard" to avoid committing the .project file.
 
 Protocol notes: If you are using anonymous access via pserver, just select that.

diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 7901c54c007a81ddd0174b9697803844e2424c40..3c91db7bed038f7ba28a4e7554cc6e63c5d91958 100644 (file)
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -296,7 +296,7 @@ they correspond to these IP addresses.
 selectively enable/disable services per repository::
        To enable 'git archive --remote' and disable 'git fetch' against
        a repository, have the following in the configuration file in the
 selectively enable/disable services per repository::
        To enable 'git archive --remote' and disable 'git fetch' against
        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').
 +
 ----------------------------------------------------------------

diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt
index 8144527ae026803a4ad87d4fc07b638b85f48075..c1a3e8bf073f7aef89989356e985861644530a86 100644 (file)
--- a/Documentation/git-gui.txt
+++ b/Documentation/git-gui.txt
@@ -35,7 +35,7 @@ blame::
 
 browser::
        Start a tree browser showing all files in the specified
 
 browser::
        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.
 
 citool::
        browser are opened in the blame viewer.
 
 citool::

diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index a9f1909a114855a7afa60641cad86770d42a7403..dbc91f98ffbee198bed7d2eeeb2758687c17adf8 100644 (file)
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -27,9 +27,9 @@ in the current working directory.  Note that:
    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
    ls-tree -r HEAD dir' to list the contents of the tree (that is
    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
    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
    --full-tree option.
 
    However, the current working directory can be ignored by passing
    --full-tree option.
 

diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 2703648eb44ab789a80caad955d09cc942d19681..ac7e6a38c0d9b62bb5b2d7c73006db0a6fe7c6a4 100644 (file)
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -275,7 +275,7 @@ These options can be used to modify 'git p4 submit' behavior.
 --origin <commit>::
        Upstream location from which commits are identified to submit to
        p4.  By default, this is the most recent p4 commit reachable
 --origin <commit>::
        Upstream location from which commits are identified to submit to
        p4.  By default, this is the most recent p4 commit reachable

-       from 'HEAD'.
+       from `HEAD`.

 
 -M::
        Detect renames.  See linkgit:git-diff[1].  Renames will be
 
 -M::
        Detect renames.  See linkgit:git-diff[1].  Renames will be

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 499df56703b255eadca56c2fb8deff99ce4ca487..dfd6b27682ff87fcf960a3f6f7dff0051d2b958f 100644 (file)
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -167,7 +167,7 @@ This option is only applicable when listing tags without annotation lines.
 
 --[no-]merged [<commit>]::
        Only list tags whose tips are reachable, or not reachable
 
 --[no-]merged [<commit>]::
        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).
 
 CONFIGURATION
        if not specified).
 
 CONFIGURATION

diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 53ce1d099c9c4b897ad7301cb91bae62cde8406c..a4de50ad227bb1653977ee9502a3df20afefaf92 100644 (file)
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -298,7 +298,7 @@ Supported if the helper has the "fetch" capability.
        is followed by a blank line). For example, the following would
        be two batches of 'push', the first asking the remote-helper
        to push the local ref 'master' to the remote ref 'master' and
        is followed by a blank line). For example, the following would
        be two batches of 'push', the first asking the remote-helper
        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
        by the '+').
 +
        asking to push ref 'foo' to ref 'bar' (forced update requested
        by the '+').
 +

diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 15879b381d395c376c2837f9fc36bada5e65d972..abae36398351491db4bab57db6363e3597ade79d 100644 (file)
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -28,8 +28,8 @@ blobs contained in a commit.
   first match in the following rules:
 
   . If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
   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`
+    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.
-'FETCH_HEAD' records the branch which you fetched from a remote repository
+`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

 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
-way, to record the position of the 'HEAD' before their operation, so that
+`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

 you can easily change the tip of the branch back to the state before you ran
 them.
 you can easily change the tip of the branch back to the state before you ran
 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`.
 +
 Note that any of the 'refs/*' cases above may come either from
 when you run `git cherry-pick`.
 +
 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}'::
   A ref followed by the suffix '@' with a date specification
 
 '<refname>@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
   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\}'::
   The suffix '@\{push}' reports the branch "where we would push to" if
   `git push` were run while `branchname` was checked out (or the current
 '<branchname>@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
   The suffix '@\{push}' reports the branch "where we would push to" if
   `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
   that corresponds to that branch (i.e., something in 'refs/remotes/').
 +
   in a remote repository, of course, we report the local tracking branch
   that corresponds to that branch (i.e., something in 'refs/remotes/').
 +


@@ -283,12 +283,12 @@ To summarize:
 '<rev1>..<rev2>'::
        Include commits that are reachable from <rev2> but exclude
        those that are reachable from <rev1>.  When either <rev1> or
 '<rev1>..<rev2>'::
        Include commits that are reachable from <rev2> but exclude
        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>'::
        Include commits that are reachable from either <rev1> or
        <rev2> but exclude those that are reachable from both.  When
 
 '<rev1>\...<rev2>'::
        Include commits that are reachable from either <rev1> or
        <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}@'::
   A suffix '{caret}' followed by an at sign is the same as listing
 
 '<rev>{caret}@', e.g. 'HEAD{caret}@'::
   A suffix '{caret}' followed by an at sign is the same as listing