Skip to content

Commit 83456b1

Browse files
Michael J Grubergitster
authored andcommitted
revisions.txt: consistent use of quotes
Our use of quotes is inconsistent everywhere and within some files. Before reworking the structure of revisions.txt, make the quotes consistent: `git command` 'some snippet or term' The former gets typeset as code, the latter with some form of emphasis. the man backend uses two types of emphasis. Signed-off-by: Michael J Gruber <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6acef04 commit 83456b1

File tree

1 file changed

+52
-52
lines changed

1 file changed

+52
-52
lines changed

Documentation/revisions.txt

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -13,64 +13,64 @@ blobs contained in a commit.
1313
name the same commit object if there are no other object in
1414
your repository whose object name starts with dae86e.
1515

16-
* An output from 'git describe'; i.e. a closest tag, optionally
16+
* An output from `git describe`; i.e. a closest tag, optionally
1717
followed by a dash and a number of commits, followed by a dash, a
18-
`g`, and an abbreviated object name.
18+
'g', and an abbreviated object name.
1919

2020
* A symbolic ref name. E.g. 'master' typically means the commit
21-
object referenced by refs/heads/master. If you
22-
happen to have both heads/master and tags/master, you can
21+
object referenced by 'refs/heads/master'. If you
22+
happen to have both 'heads/master' and 'tags/master', you can
2323
explicitly say 'heads/master' to tell git which one you mean.
24-
When ambiguous, a `<name>` is disambiguated by taking the
24+
When ambiguous, a '<name>' is disambiguated by taking the
2525
first match in the following rules:
2626

27-
. if `$GIT_DIR/<name>` exists, that is what you mean (this is usually
28-
useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`
29-
and `CHERRY_PICK_HEAD`);
27+
. if '$GIT_DIR/<name>' exists, that is what you mean (this is usually
28+
useful only for 'HEAD', 'FETCH_HEAD', 'ORIG_HEAD', 'MERGE_HEAD'
29+
and 'CHERRY_PICK_HEAD');
3030

31-
. otherwise, `refs/<name>` if exists;
31+
. otherwise, 'refs/<name>' if exists;
3232

33-
. otherwise, `refs/tags/<name>` if exists;
33+
. otherwise, 'refs/tags/<name>' if exists;
3434

35-
. otherwise, `refs/heads/<name>` if exists;
35+
. otherwise, 'refs/heads/<name>' if exists;
3636

37-
. otherwise, `refs/remotes/<name>` if exists;
37+
. otherwise, 'refs/remotes/<name>' if exists;
3838

39-
. otherwise, `refs/remotes/<name>/HEAD` if exists.
39+
. otherwise, 'refs/remotes/<name>/HEAD' if exists.
4040
+
41-
HEAD names the commit your changes in the working tree is based on.
42-
FETCH_HEAD records the branch you fetched from a remote repository
43-
with your last 'git fetch' invocation.
44-
ORIG_HEAD is created by commands that moves your HEAD in a drastic
45-
way, to record the position of the HEAD before their operation, so that
41+
'HEAD' names the commit your changes in the working tree is based on.
42+
'FETCH_HEAD' records the branch you fetched from a remote repository
43+
with your last `git fetch` invocation.
44+
'ORIG_HEAD' is created by commands that moves your 'HEAD' in a drastic
45+
way, to record the position of the 'HEAD' before their operation, so that
4646
you can change the tip of the branch back to the state before you ran
4747
them easily.
48-
MERGE_HEAD records the commit(s) you are merging into your branch
49-
when you run 'git merge'.
50-
CHERRY_PICK_HEAD records the commit you are cherry-picking
51-
when you run 'git cherry-pick'.
48+
'MERGE_HEAD' records the commit(s) you are merging into your branch
49+
when you run `git merge`.
50+
'CHERRY_PICK_HEAD' records the commit you are cherry-picking
51+
when you run `git cherry-pick`.
5252
+
53-
Note that any of the `refs/*` cases above may come either from
54-
the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
53+
Note that any of the 'refs/*' cases above may come either from
54+
the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
5555

5656
* A ref followed by the suffix '@' with a date specification
5757
enclosed in a brace
5858
pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1
5959
second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value
6060
of the ref at a prior point in time. This suffix may only be
6161
used immediately following a ref name and the ref must have an
62-
existing log ($GIT_DIR/logs/<ref>). Note that this looks up the state
62+
existing log ('$GIT_DIR/logs/<ref>'). Note that this looks up the state
6363
of your *local* ref at a given time; e.g., what was in your local
64-
`master` branch last week. If you want to look at commits made during
65-
certain times, see `--since` and `--until`.
64+
'master' branch last week. If you want to look at commits made during
65+
certain times, see '--since' and '--until'.
6666

6767
* A ref followed by the suffix '@' with an ordinal specification
6868
enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
6969
the n-th prior value of that ref. For example 'master@\{1\}'
7070
is the immediate prior value of 'master' while 'master@\{5\}'
7171
is the 5th prior value of 'master'. This suffix may only be used
7272
immediately following a ref name and the ref must have an existing
73-
log ($GIT_DIR/logs/<ref>).
73+
log ('$GIT_DIR/logs/<ref>').
7474

7575
* You can use the '@' construct with an empty ref part to get at a
7676
reflog of the current branch. For example, if you are on the
@@ -98,36 +98,36 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
9898
the usage of this form.
9999

100100
* A suffix '{caret}' followed by an object type name enclosed in
101-
brace pair (e.g. `v0.99.8{caret}\{commit\}`) means the object
101+
brace pair (e.g. 'v0.99.8{caret}\{commit\}') means the object
102102
could be a tag, and dereference the tag recursively until an
103103
object of that type is found or the object cannot be
104-
dereferenced anymore (in which case, barf). `rev{caret}0`
105-
introduced earlier is a short-hand for `rev{caret}\{commit\}`.
104+
dereferenced anymore (in which case, barf). 'rev{caret}0'
105+
introduced earlier is a short-hand for 'rev{caret}\{commit\}'.
106106

107107
* A suffix '{caret}' followed by an empty brace pair
108-
(e.g. `v0.99.8{caret}\{\}`) means the object could be a tag,
108+
(e.g. 'v0.99.8{caret}\{\}') means the object could be a tag,
109109
and dereference the tag recursively until a non-tag object is
110110
found.
111111

112112
* A suffix '{caret}' to a revision parameter followed by a brace
113-
pair that contains a text led by a slash (e.g. `HEAD^{/fix nasty bug}`):
114-
this is the same as `:/fix nasty bug` syntax below except that
113+
pair that contains a text led by a slash (e.g. 'HEAD^{/fix nasty bug}'):
114+
this is the same as ':/fix nasty bug' syntax below except that
115115
it returns the youngest matching commit which is reachable from
116116
the ref before '{caret}'.
117117

118-
* A colon, followed by a slash, followed by a text (e.g. `:/fix nasty bug`): this names
118+
* A colon, followed by a slash, followed by a text (e.g. ':/fix nasty bug'): this names
119119
a commit whose commit message matches the specified regular expression.
120120
This name returns the youngest matching commit which is
121121
reachable from any ref. If the commit message starts with a
122122
'!', you have to repeat that; the special sequence ':/!',
123123
followed by something else than '!' is reserved for now.
124124
The regular expression can match any part of the commit message. To
125-
match messages starting with a string, one can use e.g. `:/^foo`.
125+
match messages starting with a string, one can use e.g. ':/^foo'.
126126

127-
* A suffix ':' followed by a path (e.g. `HEAD:README`); this names the blob or tree
127+
* A suffix ':' followed by a path (e.g. 'HEAD:README'); this names the blob or tree
128128
at the given path in the tree-ish object named by the part
129129
before the colon.
130-
':path' (with an empty part before the colon, e.g. `:README`)
130+
':path' (with an empty part before the colon, e.g. ':README')
131131
is a special case of the syntax described next: content
132132
recorded in the index at the given path.
133133
A path starting with './' or '../' is relative to current working directory.
@@ -136,9 +136,9 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
136136
the same tree structure with the working tree.
137137

138138
* A colon, optionally followed by a stage number (0 to 3) and a
139-
colon, followed by a path (e.g. `:0:README`); this names a blob object in the
139+
colon, followed by a path (e.g. ':0:README'); this names a blob object in the
140140
index at the given path. Missing stage number (and the colon
141-
that follows it, e.g. `:README`) names a stage 0 entry. During a merge, stage
141+
that follows it, e.g. ':README') names a stage 0 entry. During a merge, stage
142142
1 is the common ancestor, stage 2 is the target branch's version
143143
(typically the current branch), and stage 3 is the version from
144144
the branch being merged.
@@ -175,31 +175,31 @@ G H I J
175175
SPECIFYING RANGES
176176
-----------------
177177

178-
History traversing commands such as 'git log' operate on a set
178+
History traversing commands such as `git log` operate on a set
179179
of commits, not just a single commit. To these commands,
180180
specifying a single revision with the notation described in the
181181
previous section means the set of commits reachable from that
182182
commit, following the commit ancestry chain.
183183

184-
To exclude commits reachable from a commit, a prefix `{caret}`
185-
notation is used. E.g. `{caret}r1 r2` means commits reachable
186-
from `r2` but exclude the ones reachable from `r1`.
184+
To exclude commits reachable from a commit, a prefix '{caret}'
185+
notation is used. E.g. '{caret}r1 r2' means commits reachable
186+
from 'r2' but exclude the ones reachable from 'r1'.
187187

188188
This set operation appears so often that there is a shorthand
189-
for it. When you have two commits `r1` and `r2` (named according
189+
for it. When you have two commits 'r1' and 'r2' (named according
190190
to the syntax explained in SPECIFYING REVISIONS above), you can ask
191191
for commits that are reachable from r2 excluding those that are reachable
192-
from r1 by `{caret}r1 r2` and it can be written as `r1..r2`.
192+
from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.
193193

194-
A similar notation `r1\...r2` is called symmetric difference
195-
of `r1` and `r2` and is defined as
196-
`r1 r2 --not $(git merge-base --all r1 r2)`.
194+
A similar notation 'r1\...r2' is called symmetric difference
195+
of 'r1' and 'r2' and is defined as
196+
'r1 r2 --not $(git merge-base --all r1 r2)'.
197197
It is the set of commits that are reachable from either one of
198-
`r1` or `r2` but not from both.
198+
'r1' or 'r2' but not from both.
199199

200200
Two other shorthands for naming a set that is formed by a commit
201-
and its parent commits exist. The `r1{caret}@` notation means all
202-
parents of `r1`. `r1{caret}!` includes commit `r1` but excludes
201+
and its parent commits exist. The 'r1{caret}@' notation means all
202+
parents of 'r1'. 'r1{caret}!' includes commit 'r1' but excludes
203203
all of its parents.
204204

205205
Here are a handful of examples:

0 commit comments

Comments
 (0)