Documentation: format full commands in typewriter font

Use `code snippet` style instead of 'emphasis' for `git cmd ...`
according to the following rules:

* The SYNOPSIS sections are left untouched.

* If the intent is that the user type the command exactly as given, it
is `code`.
If the user is only loosely referred to a command and/or option, it
remains 'emphasised'.

Signed-off-by: Thomas Rast <trast@student.ethz.ch>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 23a965eed7286ba9f92417bdde2f6dd1a0c57bbd..3e96a2779a8e4b07910ac647f17afbf2a1166b03 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -741,15 +741,15 @@ diff.mnemonicprefix::
        standard "a/" and "b/" depending on what is being compared.  When
        this configuration is in effect, reverse diff output also swaps
        the order of the prefixes:
        standard "a/" and "b/" depending on what is being compared.  When
        this configuration is in effect, reverse diff output also swaps
        the order of the prefixes:

-'git-diff';;
+`git diff`;;

        compares the (i)ndex and the (w)ork tree;
        compares the (i)ndex and the (w)ork tree;

-'git-diff HEAD';;
+`git diff HEAD`;;

         compares a (c)ommit and the (w)ork tree;
         compares a (c)ommit and the (w)ork tree;

-'git diff --cached';;
+`git diff --cached`;;

        compares a (c)ommit and the (i)ndex;
        compares a (c)ommit and the (i)ndex;

-'git-diff HEAD:file1 file2';;
+`git diff HEAD:file1 file2`;;

        compares an (o)bject and a (w)ork tree entity;
        compares an (o)bject and a (w)ork tree entity;

-'git diff --no-index a b';;
+`git diff --no-index a b`;;

        compares two non-git things (1) and (2).
 
 diff.renameLimit::
        compares two non-git things (1) and (2).
 
 diff.renameLimit::


@@ -1015,7 +1015,7 @@ gui.spellingdictionary::
        off.
 
 gui.fastcopyblame::
        off.
 
 gui.fastcopyblame::

-       If true, 'git gui blame' uses '-C' instead of '-C -C' for original
+       If true, 'git gui blame' uses `-C` instead of `-C -C` for original

        location detection. It makes blame significantly faster on huge
        repositories at the expense of less thorough copy detection.
 
        location detection. It makes blame significantly faster on huge
        repositories at the expense of less thorough copy detection.
 

diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 1f1b19996baa34b20bf08f4eb2889403cbc4c45d..f74fcf37378239daded405833737481cdccae8c7 100644 (file)
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -39,7 +39,7 @@ The `git add` command will not add ignored files by default.  If any
 ignored files were explicitly specified on the command line, `git add`
 will fail with a list of ignored files.  Ignored files reached by
 directory recursion or filename globbing performed by Git (quote your
 ignored files were explicitly specified on the command line, `git add`
 will fail with a list of ignored files.  Ignored files reached by
 directory recursion or filename globbing performed by Git (quote your

-globs before the shell) will be silently ignored.  The `add` command can
+globs before the shell) will be silently ignored.  The 'git add' command can

 be used to add ignored files with the `-f` (force) option.
 
 Please see linkgit:git-commit[1] for alternative ways to add content to a
 be used to add ignored files with the `-f` (force) option.
 
 Please see linkgit:git-commit[1] for alternative ways to add content to a

diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index 99a7c14700ffa06090534682283320fef5001815..19b1daf09c2880dc5bf476665c61766eced457f6 100644 (file)
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -294,7 +294,7 @@ To get a checkout with the Eclipse CVS client:
 Protocol notes: If you are using anonymous access via pserver, just select that.
 Those using SSH access should choose the 'ext' protocol, and configure 'ext'
 access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
 Protocol notes: If you are using anonymous access via pserver, just select that.
 Those using SSH access should choose the 'ext' protocol, and configure 'ext'
 access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to

-"'git cvsserver'". Note that password support is not good when using 'ext',
+"`git cvsserver`". Note that password support is not good when using 'ext',

 you will definitely want to have SSH keys setup.
 
 Alternatively, you can just use the non-standard extssh protocol that Eclipse
 you will definitely want to have SSH keys setup.
 
 Alternatively, you can just use the non-standard extssh protocol that Eclipse

diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 394a77a35f2019f5c86f9e90e94b88cf56da04ae..544836acd530cdbdc8498ddce3475c2c8c7e7dd0 100644 (file)
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -129,8 +129,8 @@ convenience functions, too.  For example, calling 'skip_commit "$@"'
 will leave out the current commit (but not its changes! If you want
 that, use 'git-rebase' instead).
 +
 will leave out the current commit (but not its changes! If you want
 that, use 'git-rebase' instead).
 +

-You can also use the 'git_commit_non_empty_tree "$@"' instead of
-'git commit-tree "$@"' if you don't wish to keep commits with a single parent
+You can also use the `git_commit_non_empty_tree "$@"` instead of
+`git commit-tree "$@"` if you don't wish to keep commits with a single parent

 and that makes no change to the tree.
 
 --tag-name-filter <command>::
 and that makes no change to the tree.
 
 --tag-name-filter <command>::


@@ -179,7 +179,7 @@ the nearest ancestor that was not excluded.
        and only one parent, it will hence keep merges points. Also, this
        option is not compatible with the use of '--commit-filter'. Though you
        just need to use the function 'git_commit_non_empty_tree "$@"' instead
        and only one parent, it will hence keep merges points. Also, this
        option is not compatible with the use of '--commit-filter'. Though you
        just need to use the function 'git_commit_non_empty_tree "$@"' instead

-       of the 'git commit-tree "$@"' idiom in your commit filter to make that
+       of the `git commit-tree "$@"` idiom in your commit filter to make that

        happen.
 
 --original <namespace>::
        happen.
 
 --original <namespace>::

diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 4cd9cdf9056fe78b3acbbf62aa080b1e47907b0a..01eee677f2ff5ea1e99587e4fbda90b0d7c23f7d 100644 (file)
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -50,7 +50,7 @@ Housekeeping is required if there are too many loose objects or
 too many packs in the repository. If the number of loose objects
 exceeds the value of the `gc.auto` configuration variable, then
 all loose objects are combined into a single pack using
 too many packs in the repository. If the number of loose objects
 exceeds the value of the `gc.auto` configuration variable, then
 all loose objects are combined into a single pack using

-'git-repack -d -l'.  Setting the value of `gc.auto` to 0
+`git-repack -d -l`.  Setting the value of `gc.auto` to 0

 disables automatic packing of loose objects.
 +
 If the number of packs exceeds the value of `gc.autopacklimit`,
 disables automatic packing of loose objects.
 +
 If the number of packs exceeds the value of `gc.autopacklimit`,

diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index c3fdccb4c2f66b8b3a3c6b60b21feac881b06cb4..1f89d3680043cc98ad39facb1f43ae770ff66e14 100644 (file)
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -28,7 +28,7 @@ in the current working directory.  Note that:
    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
    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

-   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.
    However, the current working directory can be ignored by passing
    --full-tree option.
    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.


@@ -84,7 +84,7 @@ Output Format
 
 Unless the `-z` option is used, TAB, LF, and backslash characters
 in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
 
 Unless the `-z` option is used, TAB, LF, and backslash characters
 in pathnames are represented as `\t`, `\n`, and `\\`, respectively.

-This output format is compatible with what '--index-info --stdin' of
+This output format is compatible with what `--index-info --stdin` of

 'git update-index' expects.
 
 When the `-l` option is used, format changes to
 'git update-index' expects.
 
 When the `-l` option is used, format changes to

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 3277f4e26dae2ff346842bb1b698d20fd26a373f..04c21d33cfa6f94834bf080f8094b50099648ad6 100644 (file)
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -193,7 +193,7 @@ After seeing a conflict, you can do two things:
 
  * Decide not to merge.  The only clean-ups you need are to reset
    the index file to the `HEAD` commit to reverse 2. and to clean
 
  * Decide not to merge.  The only clean-ups you need are to reset
    the index file to the `HEAD` commit to reverse 2. and to clean

-   up working tree changes made by 2. and 3.; 'git-reset --hard' can
+   up working tree changes made by 2. and 3.; `git-reset --hard` can

    be used for this.
 
  * Resolve the conflicts.  Git will mark the conflicts in
    be used for this.
 
  * Resolve the conflicts.  Git will mark the conflicts in


@@ -202,19 +202,19 @@ After seeing a conflict, you can do two things:
 
 You can work through the conflict with a number of tools:
 
 
 You can work through the conflict with a number of tools:
 

- * Use a mergetool.  'git mergetool' to launch a graphical
+ * Use a mergetool.  `git mergetool` to launch a graphical

    mergetool which will work you through the merge.
 
    mergetool which will work you through the merge.
 

- * Look at the diffs.  'git diff' will show a three-way diff,
+ * Look at the diffs.  `git diff` will show a three-way diff,

    highlighting changes from both the HEAD and their versions.
 
    highlighting changes from both the HEAD and their versions.
 

- * Look at the diffs on their own. 'git log --merge -p <path>'
+ * Look at the diffs on their own. `git log --merge -p <path>`

    will show diffs first for the HEAD version and then
    their version.
 
    will show diffs first for the HEAD version and then
    their version.
 

- * Look at the originals.  'git show :1:filename' shows the
-   common ancestor, 'git show :2:filename' shows the HEAD
-   version and 'git show :3:filename' shows their version.
+ * Look at the originals.  `git show :1:filename` shows the
+   common ancestor, `git show :2:filename` shows the HEAD
+   version and `git show :3:filename` shows their version.

 
 
 EXAMPLES
 
 
 EXAMPLES

diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt
index 65a0da508a6be033e46850dc46b4fb700c93ad50..fde209258234edd221dea2f5b096c78f1978eeb4 100644 (file)
--- a/Documentation/git-replace.txt
+++ b/Documentation/git-replace.txt
@@ -65,7 +65,7 @@ OPTIONS
 BUGS
 ----
 Comparing blobs or trees that have been replaced with those that
 BUGS
 ----
 Comparing blobs or trees that have been replaced with those that

-replace them will not work properly. And using 'git reset --hard' to
+replace them will not work properly. And using `git reset --hard` to

 go back to a replaced commit will move the branch to the replacement
 commit instead of the replaced commit.
 
 go back to a replaced commit will move the branch to the replacement
 commit instead of the replaced commit.
 

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 5e1175800a11d9e6a63102063af782757464d72e..36f3bc30ee653f8cdaf9d8c23089f6829dbada96 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -20,8 +20,8 @@ effect of an earlier commit (often a faulty one).  If you want to
 throw away all uncommitted changes in your working directory, you
 should see linkgit:git-reset[1], particularly the '--hard' option.  If
 you want to extract specific files as they were in another commit, you
 throw away all uncommitted changes in your working directory, you
 should see linkgit:git-reset[1], particularly the '--hard' option.  If
 you want to extract specific files as they were in another commit, you

-should see linkgit:git-checkout[1], specifically the 'git checkout
-<commit> -- <filename>' syntax.  Take care with these alternatives as
+should see linkgit:git-checkout[1], specifically the `git checkout
+<commit> -- <filename>` syntax.  Take care with these alternatives as

 both will discard uncommitted changes in your working directory.
 
 OPTIONS
 both will discard uncommitted changes in your working directory.
 
 OPTIONS

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 3f14b727b899fbf3b4f7cb6513bd1b14e5938160..f001d0ecc06f71c01e94dbca6d6bbc0c9dad185f 100644 (file)
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -20,7 +20,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------
 

-Use 'git stash' when you want to record the current state of the
+Use `git stash` when you want to record the current state of the

 working directory and the index, but want to go back to a clean
 working directory.  The command saves your local modifications away
 and reverts the working directory to match the `HEAD` commit.
 working directory and the index, but want to go back to a clean
 working directory.  The command saves your local modifications away
 and reverts the working directory to match the `HEAD` commit.

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 4ef70c42ebf512ee6dc946ca2ceee284b3211b54..68f656ce446a238e7275ceebfb5e7ea39c28817f 100644 (file)
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -114,8 +114,8 @@ init::
        The key used in .git/config is `submodule.$name.url`.
        This command does not alter existing information in .git/config.
        You can then customize the submodule clone URLs in .git/config
        The key used in .git/config is `submodule.$name.url`.
        This command does not alter existing information in .git/config.
        You can then customize the submodule clone URLs in .git/config

-       for your local setup and proceed to 'git submodule update';
-       you can also just use 'git submodule update --init' without
+       for your local setup and proceed to `git submodule update`;
+       you can also just use `git submodule update --init` without

        the explicit 'init' step if you do not intend to customize
        any submodule locations.
 
        the explicit 'init' step if you do not intend to customize
        any submodule locations.
 

diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index ef6aa81872eb9e67eaf8183cfd5359d97e6c772b..bb981822a470b2df6c79156db8aa94569869e43e 100644 (file)
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -20,7 +20,7 @@ OPTIONS
        Cause the logical variables to be listed. In addition, all the
        variables of the git configuration file .git/config are listed
        as well. (However, the configuration variables listing functionality
        Cause the logical variables to be listed. In addition, all the
        variables of the git configuration file .git/config are listed
        as well. (However, the configuration variables listing functionality

-       is deprecated in favor of 'git config -l'.)
+       is deprecated in favor of `git config -l`.)

 
 EXAMPLE
 --------
 
 EXAMPLE
 --------