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>
Thomas Rast committed
Jan 7, 2010 at 17:49 UTC
ca768288b650a4929bc1d58783a929a9a792e30e
12 files changed
+28
-28
Documentation/config.txt
+6
-6
@@ -741,15 +741,15 @@ diff.mnemonicprefix::
741
standard "a/" and "b/" depending on what is being compared. When
742
this configuration is in effect, reverse diff output also swaps
743
the order of the prefixes:
744
-'git-diff';;
744
+`git diff`;;
745
compares the (i)ndex and the (w)ork tree;
746
-'git-diff HEAD';;
746
+`git diff HEAD`;;
747
compares a (c)ommit and the (w)ork tree;
748
-'git diff --cached';;
748
+`git diff --cached`;;
749
compares a (c)ommit and the (i)ndex;
750
-'git-diff HEAD:file1 file2';;
750
+`git diff HEAD:file1 file2`;;
751
compares an (o)bject and a (w)ork tree entity;
752
-'git diff --no-index a b';;
752
+`git diff --no-index a b`;;
753
compares two non-git things (1) and (2).
754
755
diff.renameLimit::
@@ -1015,7 +1015,7 @@ gui.spellingdictionary::
1015
off.
1016
1017
gui.fastcopyblame::
1018
- If true, 'git gui blame' uses '-C' instead of '-C -C' for original
1018
+ If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1019
location detection. It makes blame significantly faster on huge
1020
repositories at the expense of less thorough copy detection.
1021
Documentation/git-add.txt
+1
-1
@@ -39,7 +39,7 @@ The `git add` command will not add ignored files by default. If any
39
ignored files were explicitly specified on the command line, `git add`
40
will fail with a list of ignored files. Ignored files reached by
41
directory recursion or filename globbing performed by Git (quote your
42
-globs before the shell) will be silently ignored. The `add` command can
42
+globs before the shell) will be silently ignored. The 'git add' command can
43
be used to add ignored files with the `-f` (force) option.
44
45
Please see linkgit:git-commit[1] for alternative ways to add content to a
Documentation/git-cvsserver.txt
+1
-1
@@ -294,7 +294,7 @@ To get a checkout with the Eclipse CVS client:
294
Protocol notes: If you are using anonymous access via pserver, just select that.
295
Those using SSH access should choose the 'ext' protocol, and configure 'ext'
296
access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
297
-"'git cvsserver'". Note that password support is not good when using 'ext',
297
+"`git cvsserver`". Note that password support is not good when using 'ext',
298
you will definitely want to have SSH keys setup.
299
300
Alternatively, you can just use the non-standard extssh protocol that Eclipse
Documentation/git-filter-branch.txt
+3
-3
@@ -129,8 +129,8 @@ convenience functions, too. For example, calling 'skip_commit "$@"'
129
will leave out the current commit (but not its changes! If you want
130
that, use 'git-rebase' instead).
131
+
132
-You can also use the 'git_commit_non_empty_tree "$@"' instead of
133
-'git commit-tree "$@"' if you don't wish to keep commits with a single parent
132
+You can also use the `git_commit_non_empty_tree "$@"` instead of
133
+`git commit-tree "$@"` if you don't wish to keep commits with a single parent
134
and that makes no change to the tree.
135
136
--tag-name-filter <command>::
@@ -179,7 +179,7 @@ the nearest ancestor that was not excluded.
179
and only one parent, it will hence keep merges points. Also, this
180
option is not compatible with the use of '--commit-filter'. Though you
181
just need to use the function 'git_commit_non_empty_tree "$@"' instead
182
- of the 'git commit-tree "$@"' idiom in your commit filter to make that
182
+ of the `git commit-tree "$@"` idiom in your commit filter to make that
183
happen.
184
185
--original <namespace>::
Documentation/git-gc.txt
+1
-1
@@ -50,7 +50,7 @@ Housekeeping is required if there are too many loose objects or
50
too many packs in the repository. If the number of loose objects
51
exceeds the value of the `gc.auto` configuration variable, then
52
all loose objects are combined into a single pack using
53
-'git-repack -d -l'. Setting the value of `gc.auto` to 0
53
+`git-repack -d -l`. Setting the value of `gc.auto` to 0
54
disables automatic packing of loose objects.
55
+
56
If the number of packs exceeds the value of `gc.autopacklimit`,
Documentation/git-ls-tree.txt
+2
-2
@@ -28,7 +28,7 @@ in the current working directory. Note that:
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
31
- root level (e.g. 'git ls-tree -r HEAD:sub dir') in this case, as that
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.
33
However, the current working directory can be ignored by passing
34
--full-tree option.
@@ -84,7 +84,7 @@ Output Format
84
85
Unless the `-z` option is used, TAB, LF, and backslash characters
86
in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
87
-This output format is compatible with what '--index-info --stdin' of
87
+This output format is compatible with what `--index-info --stdin` of
88
'git update-index' expects.
89
90
When the `-l` option is used, format changes to
Documentation/git-merge.txt
+7
-7
@@ -193,7 +193,7 @@ After seeing a conflict, you can do two things:
193
194
* Decide not to merge. The only clean-ups you need are to reset
195
the index file to the `HEAD` commit to reverse 2. and to clean
196
- up working tree changes made by 2. and 3.; 'git-reset --hard' can
196
+ up working tree changes made by 2. and 3.; `git-reset --hard` can
197
be used for this.
198
199
* Resolve the conflicts. Git will mark the conflicts in
@@ -202,19 +202,19 @@ After seeing a conflict, you can do two things:
202
203
You can work through the conflict with a number of tools:
204
205
- * Use a mergetool. 'git mergetool' to launch a graphical
205
+ * Use a mergetool. `git mergetool` to launch a graphical
206
mergetool which will work you through the merge.
207
208
- * Look at the diffs. 'git diff' will show a three-way diff,
208
+ * Look at the diffs. `git diff` will show a three-way diff,
209
highlighting changes from both the HEAD and their versions.
210
211
- * Look at the diffs on their own. 'git log --merge -p <path>'
211
+ * Look at the diffs on their own. `git log --merge -p <path>`
212
will show diffs first for the HEAD version and then
213
their version.
214
215
- * Look at the originals. 'git show :1:filename' shows the
216
- common ancestor, 'git show :2:filename' shows the HEAD
217
- version and 'git show :3:filename' shows their version.
215
+ * Look at the originals. `git show :1:filename` shows the
216
+ common ancestor, `git show :2:filename` shows the HEAD
217
+ version and `git show :3:filename` shows their version.
218
219
220
EXAMPLES
Documentation/git-replace.txt
+1
-1
@@ -65,7 +65,7 @@ OPTIONS
65
BUGS
66
----
67
Comparing blobs or trees that have been replaced with those that
68
-replace them will not work properly. And using 'git reset --hard' to
68
+replace them will not work properly. And using `git reset --hard` to
69
go back to a replaced commit will move the branch to the replacement
70
commit instead of the replaced commit.
71
Documentation/git-revert.txt
+2
-2
@@ -20,8 +20,8 @@ effect of an earlier commit (often a faulty one). If you want to
20
throw away all uncommitted changes in your working directory, you
21
should see linkgit:git-reset[1], particularly the '--hard' option. If
22
you want to extract specific files as they were in another commit, you
23
-should see linkgit:git-checkout[1], specifically the 'git checkout
24
-<commit> -- <filename>' syntax. Take care with these alternatives as
23
+should see linkgit:git-checkout[1], specifically the `git checkout
24
+<commit> -- <filename>` syntax. Take care with these alternatives as
25
both will discard uncommitted changes in your working directory.
26
27
OPTIONS
Documentation/git-stash.txt
+1
-1
@@ -20,7 +20,7 @@ SYNOPSIS
20
DESCRIPTION
21
-----------
22
23
-Use 'git stash' when you want to record the current state of the
23
+Use `git stash` when you want to record the current state of the
24
working directory and the index, but want to go back to a clean
25
working directory. The command saves your local modifications away
26
and reverts the working directory to match the `HEAD` commit.
Documentation/git-submodule.txt
+2
-2
@@ -114,8 +114,8 @@ init::
114
The key used in .git/config is `submodule.$name.url`.
115
This command does not alter existing information in .git/config.
116
You can then customize the submodule clone URLs in .git/config
117
- for your local setup and proceed to 'git submodule update';
118
- you can also just use 'git submodule update --init' without
117
+ for your local setup and proceed to `git submodule update`;
118
+ you can also just use `git submodule update --init` without
119
the explicit 'init' step if you do not intend to customize
120
any submodule locations.
121
Documentation/git-var.txt
+1
-1
@@ -20,7 +20,7 @@ OPTIONS
20
Cause the logical variables to be listed. In addition, all the
21
variables of the git configuration file .git/config are listed
22
as well. (However, the configuration variables listing functionality
23
- is deprecated in favor of 'git config -l'.)
23
+ is deprecated in favor of `git config -l`.)
24
25
EXAMPLE
26
--------