Skip to content

Commit b62c769

Browse files
Michael J Grubergitster
authored andcommitted
revisions.txt: language improvements
Signed-off-by: Michael J Gruber <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 61e508d commit b62c769

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

Documentation/revisions.txt

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ SPECIFYING REVISIONS
22
--------------------
33

44
A revision parameter '<rev>' typically, but not necessarily, names a
5-
commit object. They use what is called an 'extended SHA1'
5+
commit object. It uses what is called an 'extended SHA1'
66
syntax. Here are various ways to spell object names. The
7-
ones listed near the end of this list are to name trees and
7+
ones listed near the end of this list name trees and
88
blobs contained in a commit.
99

1010
'<sha1>', e.g. 'dae86e1950b1277e545cee180551750029cfe735', 'dae86e'::
1111
The full SHA1 object name (40-byte hexadecimal string), or
12-
a substring of such that is unique within the repository.
12+
a leading substring that is unique within the repository.
1313
E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
14-
name the same commit object if there are no other object in
14+
name the same commit object if there is no other object in
1515
your repository whose object name starts with dae86e.
1616

1717
'<describeOutput>', e.g. 'v1.7.4.2-679-g3bee7fb'::
18-
An output from `git describe`; i.e. a closest tag, optionally
18+
Output from `git describe`; i.e. a closest tag, optionally
1919
followed by a dash and a number of commits, followed by a dash, a
2020
'g', and an abbreviated object name.
2121

@@ -27,30 +27,30 @@ blobs contained in a commit.
2727
When ambiguous, a '<name>' is disambiguated by taking the
2828
first match in the following rules:
2929

30-
. if '$GIT_DIR/<name>' exists, that is what you mean (this is usually
30+
. If '$GIT_DIR/<name>' exists, that is what you mean (this is usually
3131
useful only for 'HEAD', 'FETCH_HEAD', 'ORIG_HEAD', 'MERGE_HEAD'
3232
and 'CHERRY_PICK_HEAD');
3333

34-
. otherwise, 'refs/<name>' if exists;
34+
. otherwise, 'refs/<name>' if it exists;
3535

36-
. otherwise, 'refs/tags/<refname>' if exists;
36+
. otherwise, 'refs/tags/<refname>' if it exists;
3737

38-
. otherwise, 'refs/heads/<name>' if exists;
38+
. otherwise, 'refs/heads/<name>' if it exists;
3939

40-
. otherwise, 'refs/remotes/<name>' if exists;
40+
. otherwise, 'refs/remotes/<name>' if it exists;
4141

42-
. otherwise, 'refs/remotes/<name>/HEAD' if exists.
42+
. otherwise, 'refs/remotes/<name>/HEAD' if it exists.
4343
+
44-
'HEAD' names the commit your changes in the working tree is based on.
45-
'FETCH_HEAD' records the branch you fetched from a remote repository
44+
'HEAD' names the commit on which you based the changes in the working tree.
45+
'FETCH_HEAD' records the branch which you fetched from a remote repository
4646
with your last `git fetch` invocation.
47-
'ORIG_HEAD' is created by commands that moves your 'HEAD' in a drastic
47+
'ORIG_HEAD' is created by commands that move your 'HEAD' in a drastic
4848
way, to record the position of the 'HEAD' before their operation, so that
49-
you can change the tip of the branch back to the state before you ran
50-
them easily.
51-
'MERGE_HEAD' records the commit(s) you are merging into your branch
49+
you can easily change the tip of the branch back to the state before you ran
50+
them.
51+
'MERGE_HEAD' records the commit(s) which you are merging into your branch
5252
when you run `git merge`.
53-
'CHERRY_PICK_HEAD' records the commit you are cherry-picking
53+
'CHERRY_PICK_HEAD' records the commit which you are cherry-picking
5454
when you run `git cherry-pick`.
5555
+
5656
Note that any of the 'refs/*' cases above may come either from
@@ -60,7 +60,7 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
6060
A ref followed by the suffix '@' with a date specification
6161
enclosed in a brace
6262
pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1
63-
second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value
63+
second ago\}' or '\{1979-02-26 18:30:00\}') specifies the value
6464
of the ref at a prior point in time. This suffix may only be
6565
used immediately following a ref name and the ref must have an
6666
existing log ('$GIT_DIR/logs/<ref>'). Note that this looks up the state
@@ -70,7 +70,7 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
7070

7171
'<refname>@\{<n>\}', e.g. 'master@\{1\}'::
7272
A ref followed by the suffix '@' with an ordinal specification
73-
enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
73+
enclosed in a brace pair (e.g. '\{1\}', '\{15\}') specifies
7474
the n-th prior value of that ref. For example 'master@\{1\}'
7575
is the immediate prior value of 'master' while 'master@\{5\}'
7676
is the 5th prior value of 'master'. This suffix may only be used
@@ -79,16 +79,16 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
7979

8080
'@\{<n>\}', e.g. '@\{1\}'::
8181
You can use the '@' construct with an empty ref part to get at a
82-
reflog of the current branch. For example, if you are on the
83-
branch 'blabla', then '@\{1\}' means the same as 'blabla@\{1\}'.
82+
reflog entry of the current branch. For example, if you are on
83+
branch 'blabla' then '@\{1\}' means the same as 'blabla@\{1\}'.
8484

8585
'@\{-<n>\}', e.g. '@\{-1\}'::
86-
The special construct '@\{-<n>\}' means the <n>th branch checked out
86+
The construct '@\{-<n>\}' means the <n>th branch checked out
8787
before the current one.
8888

8989
'<refname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
9090
The suffix '@\{upstream\}' to a ref (short form '<refname>@\{u\}') refers to
91-
the branch the ref is set to build on top of. Missing ref defaults
91+
the branch the ref is set to build on top of. A missing ref defaults
9292
to the current branch.
9393

9494
'<rev>{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
@@ -102,9 +102,9 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
102102
'<rev>{tilde}<n>', e.g. 'master{tilde}3'::
103103
A suffix '{tilde}<n>' to a revision parameter means the commit
104104
object that is the <n>th generation grand-parent of the named
105-
commit object, following only the first parent. I.e. '<rev>{tilde}3' is
105+
commit object, following only the first parents. I.e. '<rev>{tilde}3' is
106106
equivalent to '<rev>{caret}{caret}{caret}' which is equivalent to
107-
'<rev>{caret}1{caret}1{caret}1'. See below for a illustration of
107+
'<rev>{caret}1{caret}1{caret}1'. See below for an illustration of
108108
the usage of this form.
109109

110110
'<rev>{caret}\{<type>\}', e.g. 'v0.99.8{caret}\{commit\}'::
@@ -113,7 +113,7 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
113113
could be a tag, and dereference the tag recursively until an
114114
object of that type is found or the object cannot be
115115
dereferenced anymore (in which case, barf). '<rev>{caret}0'
116-
introduced earlier is a short-hand for '<rev>{caret}\{commit\}'.
116+
is a short-hand for '<rev>{caret}\{commit\}'.
117117

118118
'<rev>{caret}\{\}', e.g. 'v0.99.8{caret}\{\}'::
119119
A suffix '{caret}' followed by an empty brace pair
@@ -124,7 +124,7 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
124124
'<rev>{caret}\{/<text>\}', e.g. 'HEAD^{/fix nasty bug}'::
125125
A suffix '{caret}' to a revision parameter, followed by a brace
126126
pair that contains a text led by a slash,
127-
is the same as ':/fix nasty bug' syntax below except that
127+
is the same as the ':/fix nasty bug' syntax below except that
128128
it returns the youngest matching commit which is reachable from
129129
the '<rev>' before '{caret}'.
130130

@@ -133,8 +133,8 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
133133
a commit whose commit message matches the specified regular expression.
134134
This name returns the youngest matching commit which is
135135
reachable from any ref. If the commit message starts with a
136-
'!', you have to repeat that; the special sequence ':/!',
137-
followed by something else than '!' is reserved for now.
136+
'!' you have to repeat that; the special sequence ':/!',
137+
followed by something else than '!', is reserved for now.
138138
The regular expression can match any part of the commit message. To
139139
match messages starting with a string, one can use e.g. ':/^foo'.
140140

@@ -145,19 +145,19 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
145145
':path' (with an empty part before the colon)
146146
is a special case of the syntax described next: content
147147
recorded in the index at the given path.
148-
A path starting with './' or '../' is relative to current working directory.
149-
The given path will be converted to be relative to working tree's root directory.
148+
A path starting with './' or '../' is relative to the current working directory.
149+
The given path will be converted to be relative to the working tree's root directory.
150150
This is most useful to address a blob or tree from a commit or tree that has
151-
the same tree structure with the working tree.
151+
the same tree structure as the working tree.
152152

153153
':<n>:<path>', e.g. ':0:README', ':README'::
154154
A colon, optionally followed by a stage number (0 to 3) and a
155155
colon, followed by a path, names a blob object in the
156-
index at the given path. Missing stage number (and the colon
156+
index at the given path. A missing stage number (and the colon
157157
that follows it) names a stage 0 entry. During a merge, stage
158158
1 is the common ancestor, stage 2 is the target branch's version
159159
(typically the current branch), and stage 3 is the version from
160-
the branch being merged.
160+
the branch which is being merged.
161161

162162
Here is an illustration, by Jon Loeliger. Both commit nodes B
163163
and C are parents of commit node A. Parent commits are ordered

0 commit comments

Comments
 (0)