Skip to content

Commit ba020ef

Browse files
Jonathan Niedergitster
Jonathan Nieder
authored and
gitster
committed
manpages: italicize git command names (which were in teletype font)
The names of git commands are not meant to be entered at the commandline; they are just names. So we render them in italics, as is usual for command names in manpages. Using doit () { perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }' } for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \ merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt do doit <"$i" >"$i+" && mv "$i+" "$i" done git diff . Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 0979c10 commit ba020ef

File tree

117 files changed

+712
-712
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+712
-712
lines changed

‎Documentation/config.txt‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The values following the equals sign in variable assign are all either
6363
a string, an integer, or a boolean. Boolean values may be given as yes/no,
6464
0/1 or true/false. Case is not significant in boolean values, when
6565
converting value to the canonical form using '--bool' type specifier;
66-
`git-config` will ensure that the output is "true" or "false".
66+
'git-config' will ensure that the output is "true" or "false".
6767

6868
String values may be entirely or partially enclosed in double quotes.
6969
You need to enclose variable value in double quotes if you want to
@@ -356,8 +356,8 @@ core.pager::
356356

357357
core.whitespace::
358358
A comma separated list of common whitespace problems to
359-
notice. `git-diff` will use `color.diff.whitespace` to
360-
highlight them, and `git-apply --whitespace=error` will
359+
notice. 'git-diff' will use `color.diff.whitespace` to
360+
highlight them, and 'git-apply --whitespace=error' will
361361
consider them as errors:
362362
+
363363
* `trailing-space` treats trailing whitespaces at the end of the line
@@ -396,11 +396,11 @@ it will be treated as a shell command. For example, defining
396396
"gitk --all --not ORIG_HEAD".
397397

398398
apply.whitespace::
399-
Tells `git-apply` how to handle whitespaces, in the same way
399+
Tells 'git-apply' how to handle whitespaces, in the same way
400400
as the '--whitespace' option. See linkgit:git-apply[1].
401401

402402
branch.autosetupmerge::
403-
Tells `git-branch` and `git-checkout` to setup new branches
403+
Tells 'git-branch' and 'git-checkout' to setup new branches
404404
so that linkgit:git-pull[1] will appropriately merge from the
405405
starting point branch. Note that even if this option is not set,
406406
this behavior can be chosen per-branch using the `--track`
@@ -411,7 +411,7 @@ branch.autosetupmerge::
411411
branch. This option defaults to true.
412412

413413
branch.autosetuprebase::
414-
When a new branch is created with `git-branch` or `git-checkout`
414+
When a new branch is created with 'git-branch' or 'git-checkout'
415415
that tracks another branch, this variable tells git to set
416416
up pull to rebase instead of merge (see "branch.<name>.rebase").
417417
When `never`, rebase is never automatically set to true.
@@ -426,20 +426,20 @@ branch.autosetuprebase::
426426
This option defaults to never.
427427

428428
branch.<name>.remote::
429-
When in branch <name>, it tells `git-fetch` which remote to fetch.
430-
If this option is not given, `git-fetch` defaults to remote "origin".
429+
When in branch <name>, it tells 'git-fetch' which remote to fetch.
430+
If this option is not given, 'git-fetch' defaults to remote "origin".
431431

432432
branch.<name>.merge::
433-
When in branch <name>, it tells `git-fetch` the default
433+
When in branch <name>, it tells 'git-fetch' the default
434434
refspec to be marked for merging in FETCH_HEAD. The value is
435435
handled like the remote part of a refspec, and must match a
436436
ref which is fetched from the remote given by
437437
"branch.<name>.remote".
438-
The merge information is used by `git-pull` (which at first calls
439-
`git-fetch`) to lookup the default branch for merging. Without
440-
this option, `git-pull` defaults to merge the first refspec fetched.
438+
The merge information is used by 'git-pull' (which at first calls
439+
'git-fetch') to lookup the default branch for merging. Without
440+
this option, 'git-pull' defaults to merge the first refspec fetched.
441441
Specify multiple values to get an octopus merge.
442-
If you wish to setup `git-pull` so that it merges into <name> from
442+
If you wish to setup 'git-pull' so that it merges into <name> from
443443
another branch in the local repository, you can point
444444
branch.<name>.merge to the desired branch, and use the special setting
445445
`.` (a period) for branch.<name>.remote.
@@ -513,7 +513,7 @@ color.interactive::
513513
colors only when the output is to the terminal. Defaults to false.
514514

515515
color.interactive.<slot>::
516-
Use customized color for `git-add --interactive`
516+
Use customized color for 'git-add --interactive'
517517
output. `<slot>` may be `prompt`, `header`, or `help`, for
518518
three distinct types of normal output from interactive
519519
programs. The values of these variables may be specified as
@@ -550,14 +550,14 @@ color.ui::
550550
take precedence over this setting. Defaults to false.
551551

552552
diff.autorefreshindex::
553-
When using `git-diff` to compare with work tree
553+
When using 'git-diff' to compare with work tree
554554
files, do not consider stat-only change as changed.
555555
Instead, silently run `git update-index --refresh` to
556556
update the cached stat information for paths whose
557557
contents in the work tree match the contents in the
558558
index. This option defaults to true. Note that this
559-
affects only `git-diff` Porcelain, and not lower level
560-
`diff` commands, such as `git-diff-files`.
559+
affects only 'git-diff' Porcelain, and not lower level
560+
`diff` commands, such as 'git-diff-files'.
561561

562562
diff.external::
563563
If this config variable is set, diff generation is not
@@ -625,37 +625,37 @@ gc.autopacklimit::
625625
default value is 50. Setting this to 0 disables it.
626626

627627
gc.packrefs::
628-
`git-gc` does not run `git pack-refs` in a bare repository by
628+
'git-gc' does not run `git pack-refs` in a bare repository by
629629
default so that older dumb-transport clients can still fetch
630-
from the repository. Setting this to `true` lets `git-gc`
630+
from the repository. Setting this to `true` lets 'git-gc'
631631
to run `git pack-refs`. Setting this to `false` tells
632-
`git-gc` never to run `git pack-refs`. The default setting is
632+
'git-gc' never to run `git pack-refs`. The default setting is
633633
`notbare`. Enable it only when you know you do not have to
634634
support such clients. The default setting will change to `true`
635635
at some stage, and setting this to `false` will continue to
636-
prevent `git pack-refs` from being run from `git-gc`.
636+
prevent `git pack-refs` from being run from 'git-gc'.
637637

638638
gc.pruneexpire::
639-
When `git-gc` is run, it will call `prune --expire 2.weeks.ago`.
639+
When 'git-gc' is run, it will call `prune --expire 2.weeks.ago`.
640640
Override the grace period with this config variable.
641641

642642
gc.reflogexpire::
643-
`git-reflog expire` removes reflog entries older than
643+
'git-reflog expire' removes reflog entries older than
644644
this time; defaults to 90 days.
645645

646646
gc.reflogexpireunreachable::
647-
`git-reflog expire` removes reflog entries older than
647+
'git-reflog expire' removes reflog entries older than
648648
this time and are not reachable from the current tip;
649649
defaults to 30 days.
650650

651651
gc.rerereresolved::
652652
Records of conflicted merge you resolved earlier are
653-
kept for this many days when `git-rerere gc` is run.
653+
kept for this many days when 'git-rerere gc' is run.
654654
The default is 60 days. See linkgit:git-rerere[1].
655655

656656
gc.rerereunresolved::
657657
Records of conflicted merge you have not resolved are
658-
kept for this many days when `git-rerere gc` is run.
658+
kept for this many days when 'git-rerere gc' is run.
659659
The default is 15 days. See linkgit:git-rerere[1].
660660

661661
rerere.enabled::
@@ -821,7 +821,7 @@ i18n.commitEncoding::
821821

822822
i18n.logOutputEncoding::
823823
Character encoding the commit messages are converted to when
824-
running `git-log` and friends.
824+
running 'git-log' and friends.
825825

826826
instaweb.browser::
827827
Specify the program that will be used to browse your working

‎Documentation/fetch-options.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
-f::
2323
--force::
24-
When `git-fetch` is used with `<rbranch>:<lbranch>`
24+
When 'git-fetch' is used with `<rbranch>:<lbranch>`
2525
refspec, it refuses to update the local branch
2626
`<lbranch>` unless the remote branch `<rbranch>` it
2727
fetches is a descendant of `<lbranch>`. This option
@@ -53,10 +53,10 @@ endif::git-pull[]
5353

5454
-u::
5555
--update-head-ok::
56-
By default `git-fetch` refuses to update the head which
56+
By default 'git-fetch' refuses to update the head which
5757
corresponds to the current branch. This flag disables the
58-
check. This is purely for the internal use for `git-pull`
59-
to communicate with `git-fetch`, and unless you are
58+
check. This is purely for the internal use for 'git-pull'
59+
to communicate with 'git-fetch', and unless you are
6060
implementing your own Porcelain you are not supposed to
6161
use it.
6262

‎Documentation/git-am.txt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ OPTIONS
3535

3636
-k::
3737
--keep::
38-
Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
38+
Pass `-k` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
3939

4040
-u::
4141
--utf8::
42-
Pass `-u` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
42+
Pass `-u` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
4343
The proposed commit log message taken from the e-mail
4444
is re-coded into UTF-8 encoding (configuration variable
4545
`i18n.commitencoding` can be used to specify project's
@@ -49,7 +49,7 @@ This was optional in prior versions of git, but now it is the
4949
default. You could use `--no-utf8` to override this.
5050

5151
--no-utf8::
52-
Pass `-n` flag to `git-mailinfo` (see
52+
Pass `-n` flag to 'git-mailinfo' (see
5353
linkgit:git-mailinfo[1]).
5454

5555
-3::
@@ -61,17 +61,17 @@ default. You could use `--no-utf8` to override this.
6161

6262
-b::
6363
--binary::
64-
Pass `--allow-binary-replacement` flag to `git-apply`
64+
Pass `--allow-binary-replacement` flag to 'git-apply'
6565
(see linkgit:git-apply[1]).
6666

6767
--whitespace=<option>::
68-
This flag is passed to the `git-apply` (see linkgit:git-apply[1])
68+
This flag is passed to the 'git-apply' (see linkgit:git-apply[1])
6969
program that applies
7070
the patch.
7171

7272
-C<n>::
7373
-p<n>::
74-
These flags are passed to the `git-apply` (see linkgit:git-apply[1])
74+
These flags are passed to the 'git-apply' (see linkgit:git-apply[1])
7575
program that applies
7676
the patch.
7777

@@ -97,7 +97,7 @@ default. You could use `--no-utf8` to override this.
9797
to the screen before exiting. This overrides the
9898
standard message informing you to use `--resolved`
9999
or `--skip` to handle the failure. This is solely
100-
for internal use between `git-rebase` and `git-am`.
100+
for internal use between 'git-rebase' and 'git-am'.
101101

102102
DISCUSSION
103103
----------

‎Documentation/git-apply.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ OPTIONS
6464
without using the working tree. This implies '--index'.
6565

6666
--build-fake-ancestor <file>::
67-
Newer `git-diff` output has embedded 'index information'
67+
Newer 'git-diff' output has embedded 'index information'
6868
for each blob to help identify the original version that
6969
the patch applies to. When this flag is given, and if
7070
the original versions of the blobs is available locally,
@@ -78,7 +78,7 @@ the information is read from the current index instead.
7878
Apply the patch in reverse.
7979

8080
--reject::
81-
For atomicity, `git-apply` by default fails the whole patch and
81+
For atomicity, 'git-apply' by default fails the whole patch and
8282
does not touch the working tree when some of the hunks
8383
do not apply. This option makes it apply
8484
the parts of the patch that are applicable, and leave the
@@ -102,7 +102,7 @@ the information is read from the current index instead.
102102
ever ignored.
103103

104104
--unidiff-zero::
105-
By default, `git-apply` expects that the patch being
105+
By default, 'git-apply' expects that the patch being
106106
applied is a unified diff with at least one line of context.
107107
This provides good safety measures, but breaks down when
108108
applying a diff generated with --unified=0. To bypass these
@@ -113,7 +113,7 @@ discouraged.
113113

114114
--apply::
115115
If you use any of the options marked "Turns off
116-
'apply'" above, `git-apply` reads and outputs the
116+
'apply'" above, 'git-apply' reads and outputs the
117117
information you asked without actually applying the
118118
patch. Give this flag after those flags to also apply
119119
the patch.
@@ -191,7 +191,7 @@ apply.whitespace::
191191

192192
Submodules
193193
----------
194-
If the patch contains any changes to submodules then `git-apply`
194+
If the patch contains any changes to submodules then 'git-apply'
195195
treats these changes as follows.
196196

197197
If --index is specified (explicitly or implicitly), then the submodule

‎Documentation/git-archimport.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ branches that have different roots, it will refuse to run. In that case,
2929
edit your <archive/branch> parameters to define clearly the scope of the
3030
import.
3131

32-
`git-archimport` uses `tla` extensively in the background to access the
32+
'git-archimport' uses `tla` extensively in the background to access the
3333
Arch repository.
3434
Make sure you have a recent version of `tla` available in the path. `tla` must
35-
know about the repositories you pass to `git-archimport`.
35+
know about the repositories you pass to 'git-archimport'.
3636

37-
For the initial import, `git-archimport` expects to find itself in an empty
37+
For the initial import, 'git-archimport' expects to find itself in an empty
3838
directory. To follow the development of a project that uses Arch, rerun
39-
`git-archimport` with the same parameters as the initial import to perform
39+
'git-archimport' with the same parameters as the initial import to perform
4040
incremental imports.
4141

42-
While `git-archimport` will try to create sensible branch names for the
42+
While 'git-archimport' will try to create sensible branch names for the
4343
archives that it imports, it is also possible to specify git branch names
4444
manually. To do so, write a git branch name after each <archive/branch>
4545
parameter, separated by a colon. This way, you can shorten the Arch
@@ -84,7 +84,7 @@ OPTIONS
8484

8585
-o::
8686
Use this for compatibility with old-style branch names used by
87-
earlier versions of `git-archimport`. Old-style branch names
87+
earlier versions of 'git-archimport'. Old-style branch names
8888
were category--branch, whereas new-style branch names are
8989
archive,category--branch--version. In both cases, names given
9090
on the command-line will override the automatically-generated

‎Documentation/git-archive.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ structure for the named tree, and writes it out to the standard
2020
output. If <prefix> is specified it is
2121
prepended to the filenames in the archive.
2222

23-
`git-archive` behaves differently when given a tree ID versus when
23+
'git-archive' behaves differently when given a tree ID versus when
2424
given a commit ID or tag ID. In the first case the current time is
2525
used as modification time of each file in the archive. In the latter
2626
case the commit time as recorded in the referenced commit object is
2727
used instead. Additionally the commit ID is stored in a global
2828
extended pax header if the tar format is used; it can be extracted
29-
using `git-get-tar-commit-id`. In ZIP files it is stored as a file
29+
using 'git-get-tar-commit-id'. In ZIP files it is stored as a file
3030
comment.
3131

3232
OPTIONS
@@ -57,7 +57,7 @@ OPTIONS
5757

5858
--exec=<git-upload-archive>::
5959
Used with --remote to specify the path to the
60-
`git-upload-archive` on the remote side.
60+
'git-upload-archive' on the remote side.
6161

6262
<tree-ish>::
6363
The tree or commit to produce an archive for.

‎Documentation/git-bisect.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ on the subcommand:
2626
git bisect log
2727
git bisect run <cmd>...
2828

29-
This command uses `git-rev-list --bisect` to help drive the
29+
This command uses 'git-rev-list --bisect' to help drive the
3030
binary search process to find which change introduced a bug, given an
3131
old "good" commit object name and a later "bad" commit object name.
3232

@@ -101,7 +101,7 @@ $ git bisect visualize
101101
to see the currently remaining suspects in `gitk`. `visualize` is a bit
102102
too long to type and `view` is provided as a synonym.
103103

104-
If 'DISPLAY' environment variable is not set, `git-log` is used
104+
If 'DISPLAY' environment variable is not set, 'git-log' is used
105105
instead. You can even give command line options such as `-p` and
106106
`--stat`.
107107

@@ -215,7 +215,7 @@ tweaks (e.g., s/#define DEBUG 0/#define DEBUG 1/ in a header file, or
215215
work around other problem this bisection is not interested in")
216216
applied to the revision being tested.
217217

218-
To cope with such a situation, after the inner `git-bisect` finds the
218+
To cope with such a situation, after the inner 'git-bisect' finds the
219219
next revision to test, with the "run" script, you can apply that tweak
220220
before compiling, run the real test, and after the test decides if the
221221
revision (possibly with the needed tweaks) passed the test, rewind the

‎Documentation/git-blame.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ last modified the line. Optionally, start annotating from the given revision.
2121
Also it can limit the range of lines annotated.
2222

2323
This report doesn't tell you anything about lines which have been deleted or
24-
replaced; you need to use a tool such as `git-diff` or the "pickaxe"
24+
replaced; you need to use a tool such as 'git-diff' or the "pickaxe"
2525
interface briefly mentioned in the following paragraph.
2626

2727
Apart from supporting file annotation, git also supports searching the
@@ -49,7 +49,7 @@ include::blame-options.txt[]
4949
file (see `-M`). The first number listed is the score.
5050
This is the number of alphanumeric characters detected
5151
to be moved between or within files. This must be above
52-
a certain threshold for `git-blame` to consider those lines
52+
a certain threshold for 'git-blame' to consider those lines
5353
of code to have been moved.
5454

5555
-f::
@@ -100,7 +100,7 @@ header elements later.
100100
SPECIFYING RANGES
101101
-----------------
102102

103-
Unlike `git-blame` and `git-annotate` in older git, the extent
103+
Unlike 'git-blame' and 'git-annotate' in older git, the extent
104104
of annotation can be limited to both line ranges and revision
105105
ranges. When you are interested in finding the origin for
106106
ll. 40-60 for file `foo`, you can use `-L` option like these
@@ -118,7 +118,7 @@ would limit the annotation to the body of `hello` subroutine.
118118

119119
When you are not interested in changes older than the version
120120
v2.6.18, or changes older than 3 weeks, you can use revision
121-
range specifiers similar to `git-rev-list`:
121+
range specifiers similar to 'git-rev-list':
122122

123123
git blame v2.6.18.. -- foo
124124
git blame --since=3.weeks -- foo

0 commit comments

Comments
 (0)