Skip to content

Commit b89510f

Browse files
dmellorgitster
authored andcommitted
Documentation: minor grammatical fixes in git-blame.txt.
Signed-off-by: David J. Mellor <dmellor@whistlingcat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 2364259 commit b89510f

File tree

3 files changed

+37
-38
lines changed

3 files changed

+37
-38
lines changed

Documentation/blame-options.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ of lines before or after the line given by <start>.
3939
Show raw timestamp (Default: off).
4040

4141
-S <revs-file>::
42-
Use revs from revs-file instead of calling linkgit:git-rev-list[1].
42+
Use revisions from revs-file instead of calling linkgit:git-rev-list[1].
4343

4444
--reverse::
4545
Walk history forward instead of backward. Instead of showing

Documentation/git-blame.txt

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ DESCRIPTION
1818
Annotates each line in the given file with information from the revision which
1919
last modified the line. Optionally, start annotating from the given revision.
2020

21-
Also it can limit the range of lines annotated.
21+
The command can also limit the range of lines annotated.
2222

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

@@ -48,26 +48,26 @@ include::blame-options.txt[]
4848
lines between files (see `-C`) and lines moved within a
4949
file (see `-M`). The first number listed is the score.
5050
This is the number of alphanumeric characters detected
51-
to be moved between or within files. This must be above
51+
as having been moved between or within files. This must be above
5252
a certain threshold for 'git-blame' to consider those lines
5353
of code to have been moved.
5454

5555
-f::
5656
--show-name::
57-
Show filename in the original commit. By default
58-
filename is shown if there is any line that came from a
59-
file with different name, due to rename detection.
57+
Show the filename in the original commit. By default
58+
the filename is shown if there is any line that came from a
59+
file with a different name, due to rename detection.
6060

6161
-n::
6262
--show-number::
63-
Show line number in the original commit (Default: off).
63+
Show the line number in the original commit (Default: off).
6464

6565
-s::
66-
Suppress author name and timestamp from the output.
66+
Suppress the author name and timestamp from the output.
6767

6868
-w::
69-
Ignore whitespace when comparing parent's version and
70-
child's to find where the lines came from.
69+
Ignore whitespace when comparing the parent's version and
70+
the child's to find where the lines came from.
7171

7272

7373
THE PORCELAIN FORMAT
@@ -79,17 +79,17 @@ header at the minimum has the first line which has:
7979
- 40-byte SHA-1 of the commit the line is attributed to;
8080
- the line number of the line in the original file;
8181
- the line number of the line in the final file;
82-
- on a line that starts a group of line from a different
82+
- on a line that starts a group of lines from a different
8383
commit than the previous one, the number of lines in this
8484
group. On subsequent lines this field is absent.
8585

8686
This header line is followed by the following information
8787
at least once for each commit:
8888

89-
- author name ("author"), email ("author-mail"), time
89+
- the author name ("author"), email ("author-mail"), time
9090
("author-time"), and timezone ("author-tz"); similarly
9191
for committer.
92-
- filename in the commit the line is attributed to.
92+
- the filename in the commit that the line is attributed to.
9393
- the first line of the commit log message ("summary").
9494

9595
The contents of the actual line is output after the above
@@ -100,23 +100,23 @@ header elements later.
100100
SPECIFYING RANGES
101101
-----------------
102102

103-
Unlike 'git-blame' and 'git-annotate' in older git, the extent
104-
of annotation can be limited to both line ranges and revision
103+
Unlike 'git-blame' and 'git-annotate' in older versions of git, the extent
104+
of the annotation can be limited to both line ranges and revision
105105
ranges. When you are interested in finding the origin for
106-
ll. 40-60 for file `foo`, you can use `-L` option like these
106+
lines 40-60 for file `foo`, you can use the `-L` option like so
107107
(they mean the same thing -- both ask for 21 lines starting at
108108
line 40):
109109

110110
git blame -L 40,60 foo
111111
git blame -L 40,+21 foo
112112

113-
Also you can use regular expression to specify the line range.
113+
Also you can use a regular expression to specify the line range:
114114

115115
git blame -L '/^sub hello {/,/^}$/' foo
116116

117-
would limit the annotation to the body of `hello` subroutine.
117+
which limits the annotation to the body of the `hello` subroutine.
118118

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

@@ -129,7 +129,7 @@ commit v2.6.18 or the most recent commit that is more than 3
129129
weeks old in the above example) are blamed for that range
130130
boundary commit.
131131

132-
A particularly useful way is to see if an added file have lines
132+
A particularly useful way is to see if an added file has lines
133133
created by copy-and-paste from existing files. Sometimes this
134134
indicates that the developer was being sloppy and did not
135135
refactor the code properly. You can first find the commit that
@@ -162,26 +162,26 @@ annotated.
162162
+
163163
Line numbers count from 1.
164164

165-
. The first time that commit shows up in the stream, it has various
165+
. The first time that a commit shows up in the stream, it has various
166166
other information about it printed out with a one-word tag at the
167-
beginning of each line about that "extended commit info" (author,
168-
email, committer, dates, summary etc).
167+
beginning of each line describing the extra commit information (author,
168+
email, committer, dates, summary, etc.).
169169

170-
. Unlike Porcelain format, the filename information is always
170+
. Unlike the Porcelain format, the filename information is always
171171
given and terminates the entry:
172172

173173
"filename" <whitespace-quoted-filename-goes-here>
174174
+
175-
and thus it's really quite easy to parse for some line- and word-oriented
175+
and thus it is really quite easy to parse for some line- and word-oriented
176176
parser (which should be quite natural for most scripting languages).
177177
+
178178
[NOTE]
179179
For people who do parsing: to make it more robust, just ignore any
180-
lines in between the first and last one ("<sha1>" and "filename" lines)
181-
where you don't recognize the tag-words (or care about that particular
180+
lines between the first and last one ("<sha1>" and "filename" lines)
181+
where you do not recognize the tag words (or care about that particular
182182
one) at the beginning of the "extended information" lines. That way, if
183183
there is ever added information (like the commit encoding or extended
184-
commit commentary), a blame viewer won't ever care.
184+
commit commentary), a blame viewer will not care.
185185

186186

187187
MAPPING AUTHORS

Documentation/mailmap.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,21 @@ canonical real names and email addresses.
55

66
In the simple form, each line in the file consists of the canonical
77
real name of an author, whitespace, and an email address used in the
8-
commit (enclosed by '<' and '>') to map to the name. Thus, looks like
9-
this
8+
commit (enclosed by '<' and '>') to map to the name. For example:
109
--
1110
Proper Name <commit@email.xx>
1211
--
1312

14-
The more complex forms are
13+
The more complex forms are:
1514
--
1615
<proper@email.xx> <commit@email.xx>
1716
--
18-
which allows mailmap to replace only the email part of a commit, and
17+
which allows mailmap to replace only the email part of a commit, and:
1918
--
2019
Proper Name <proper@email.xx> <commit@email.xx>
2120
--
2221
which allows mailmap to replace both the name and the email of a
23-
commit matching the specified commit email address, and
22+
commit matching the specified commit email address, and:
2423
--
2524
Proper Name <proper@email.xx> Commit Name <commit@email.xx>
2625
--
@@ -47,8 +46,8 @@ Jane Doe <jane@desktop.(none)>
4746
Joe R. Developer <joe@example.com>
4847
------------
4948

50-
Note how we don't need an entry for <jane@laptop.(none)>, because the
51-
real name of that author is correct already.
49+
Note how there is no need for an entry for <jane@laptop.(none)>, because the
50+
real name of that author is already correct.
5251

5352
Example 2: Your repository contains commits from the following
5453
authors:
@@ -62,7 +61,7 @@ claus <me@company.xx>
6261
CTO <cto@coompany.xx>
6362
------------
6463

65-
Then, you might want a `.mailmap` file looking like:
64+
Then you might want a `.mailmap` file that looks like:
6665
------------
6766
<cto@company.xx> <cto@coompany.xx>
6867
Some Dude <some@dude.xx> nick1 <bugs@company.xx>
@@ -72,4 +71,4 @@ Santa Claus <santa.claus@northpole.xx> <me@company.xx>
7271
------------
7372

7473
Use hash '#' for comments that are either on their own line, or after
75-
the email address.
74+
the email address.

0 commit comments

Comments
 (0)