Browse code

Documentation: typofixes

In addition to fixing trivial and obvious typos, be careful about
the following points:

- Spell ASCII, URL and CRC in ALL CAPS;
- Spell Linux as Capitalized;
- Do not omit periods in "i.e." and "e.g.".

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

Thomas Ackermann authored on 03/11/2014 20:37:07
Showing 19 changed files
... ...
@@ -85,7 +85,7 @@ UI, Workflows & Features
85 85
    public repository really point the commits the pusher wanted to,
86 86
    without having to "trust" the server.
87 87
 
88
- * "git interpret-trailers" is a new filter to programatically edit
88
+ * "git interpret-trailers" is a new filter to programmatically edit
89 89
     the tail end of the commit log messages.
90 90
 
91 91
  * "git help everyday" shows the "Everyday Git in 20 commands or so"
... ...
@@ -1210,7 +1210,7 @@ gc.autopacklimit::
1210 1210
 	default	value is 50.  Setting this to 0 disables it.
1211 1211
 
1212 1212
 gc.autodetach::
1213
-	Make `git gc --auto` return immediately andrun in background
1213
+	Make `git gc --auto` return immediately and run in background
1214 1214
 	if the system supports it. Default is true.
1215 1215
 
1216 1216
 gc.packrefs::
... ...
@@ -1357,7 +1357,7 @@ gpg.program::
1357 1357
 	same command-line interface as GPG, namely, to verify a detached
1358 1358
 	signature, "gpg --verify $file - <$signature" is run, and the
1359 1359
 	program is expected to signal a good signature by exiting with
1360
-	code 0, and to generate an ascii-armored detached signature, the
1360
+	code 0, and to generate an ASCII-armored detached signature, the
1361 1361
 	standard input of "gpg -bsau $key" is fed with the contents to be
1362 1362
 	signed, and the program is expected to send the result to its
1363 1363
 	standard output.
... ...
@@ -1592,7 +1592,7 @@ http.useragent::
1592 1592
 	Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1593 1593
 
1594 1594
 http.<url>.*::
1595
-	Any of the http.* options above can be applied selectively to some urls.
1595
+	Any of the http.* options above can be applied selectively to some URLs.
1596 1596
 	For a config key to match a URL, each element of the config key is
1597 1597
 	compared to that of the URL, in the following order:
1598 1598
 +
... ...
@@ -1631,8 +1631,8 @@ if the URL is `https://user@example.com/foo/bar` a config key match of
1631 1631
 +
1632 1632
 All URLs are normalized before attempting any matching (the password part,
1633 1633
 if embedded in the URL, is always ignored for matching purposes) so that
1634
-equivalent urls that are simply spelled differently will match properly.
1635
-Environment variable settings always override any matches.  The urls that are
1634
+equivalent URLs that are simply spelled differently will match properly.
1635
+Environment variable settings always override any matches.  The URLs that are
1636 1636
 matched against are those given directly to Git commands.  This means any URLs
1637 1637
 visited as a result of a redirection do not participate in matching.
1638 1638
 
... ...
@@ -119,7 +119,7 @@ developed and maintained during years or even tens of years by a lot
119 119
 of people. And as there are often many people who depend (sometimes
120 120
 critically) on such software, regressions are a really big problem.
121 121
 
122
-One such software is the linux kernel. And if we look at the linux
122
+One such software is the Linux kernel. And if we look at the Linux
123 123
 kernel, we can see that a lot of time and effort is spent to fight
124 124
 regressions. The release cycle start with a 2 weeks long merge
125 125
 window. Then the first release candidate (rc) version is tagged. And
... ...
@@ -132,7 +132,7 @@ regressions. And this time is more than 80% of the release cycle
132 132
 time. But this is not the end of the fight yet, as of course it
133 133
 continues after the release.
134 134
 
135
-And then this is what Ingo Molnar (a well known linux kernel
135
+And then this is what Ingo Molnar (a well known Linux kernel
136 136
 developer) says about his use of git bisect:
137 137
 
138 138
 _____________
... ...
@@ -98,7 +98,7 @@ clean::
98 98
 filter by pattern::
99 99
 
100 100
    This shows the files and directories to be deleted and issues an
101
-   "Input ignore patterns>>" prompt. You can input space-seperated
101
+   "Input ignore patterns>>" prompt. You can input space-separated
102 102
    patterns to exclude files and directories from deletion.
103 103
    E.g. "*.c *.h" will excludes files end with ".c" and ".h" from
104 104
    deletion. When you are satisfied with the filtered result, press
... ...
@@ -219,7 +219,7 @@ Problems related to tags:
219 219
 * Multiple tags on the same revision are not imported.
220 220
 
221 221
 If you suspect that any of these issues may apply to the repository you
222
-want to imort, consider using cvs2git:
222
+want to import, consider using cvs2git:
223 223
 
224 224
 * cvs2git (part of cvs2svn), `http://subversion.apache.org/`
225 225
 
... ...
@@ -110,7 +110,7 @@ to allow writes to, for example:
110 110
 	authdb = /etc/cvsserver/passwd
111 111
 
112 112
 ------
113
-The format of these files is username followed by the crypted password,
113
+The format of these files is username followed by the encrypted password,
114 114
 for example:
115 115
 
116 116
 ------
... ...
@@ -451,8 +451,8 @@ characteristics:
451 451
 
452 452
 * By default The BFG takes full advantage of multi-core machines,
453 453
   cleansing commit file-trees in parallel. git-filter-branch cleans
454
-  commits sequentially (ie in a single-threaded manner), though it
455
-  _is_ possible to write filters that include their own parallellism,
454
+  commits sequentially (i.e. in a single-threaded manner), though it
455
+  _is_ possible to write filters that include their own parallelism,
456 456
   in the scripts executed against each commit.
457 457
 
458 458
 * The http://rtyley.github.io/bfg-repo-cleaner/#examples[command options]
... ...
@@ -3,7 +3,7 @@ git-interpret-trailers(1)
3 3
 
4 4
 NAME
5 5
 ----
6
-git-interpret-trailers - help add stuctured information into commit messages
6
+git-interpret-trailers - help add structured information into commit messages
7 7
 
8 8
 SYNOPSIS
9 9
 --------
... ...
@@ -43,7 +43,7 @@ This means that the trimmed <token> and <value> will be separated by
43 43
 
44 44
 By default the new trailer will appear at the end of all the existing
45 45
 trailers. If there is no existing trailer, the new trailer will appear
46
-after the commit message part of the ouput, and, if there is no line
46
+after the commit message part of the output, and, if there is no line
47 47
 with only spaces at the end of the commit message part, one blank line
48 48
 will be added before the new trailer.
49 49
 
... ...
@@ -56,7 +56,7 @@ minus signs start the patch part of the message.
56 56
 
57 57
 When reading trailers, there can be whitespaces before and after the
58 58
 token, the separator and the value. There can also be whitespaces
59
-indide the token and the value.
59
+inside the token and the value.
60 60
 
61 61
 Note that 'trailers' do not follow and are not intended to follow many
62 62
 rules for RFC 822 headers. For example they do not follow the line
... ...
@@ -184,7 +184,7 @@ shown.  If the pattern does not contain a globbing character (`?`,
184 184
 	consider. Repetitions of this option accumulate exclusion patterns
185 185
 	up to the next `--all`, `--branches`, `--tags`, `--remotes`, or
186 186
 	`--glob` option (other options or arguments do not clear
187
-	accumlated patterns).
187
+	accumulated patterns).
188 188
 +
189 189
 The patterns given should not begin with `refs/heads`, `refs/tags`, or
190 190
 `refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
... ...
@@ -70,8 +70,8 @@ COMMANDS
70 70
 --username=<user>;;
71 71
 	For transports that SVN handles authentication for (http,
72 72
 	https, and plain svn), specify the username.  For other
73
-	transports (eg svn+ssh://), you must include the username in
74
-	the URL, eg svn+ssh://foo@svn.bar.com/project
73
+	transports (e.g. svn+ssh://), you must include the username in
74
+	the URL, e.g. svn+ssh://foo@svn.bar.com/project
75 75
 --prefix=<prefix>;;
76 76
 	This allows one to specify a prefix which is prepended
77 77
 	to the names of remotes if trunk/branches/tags are
... ...
@@ -170,7 +170,7 @@ may not support it yet.
170 170
 	split-index mode is already enabled and `--split-index` is
171 171
 	given again, all changes in $GIT_DIR/index are pushed back to
172 172
 	the shared index file. This mode is designed for very large
173
-	indexes that take a signficant amount of time to read or write.
173
+	indexes that take a significant amount of time to read or write.
174 174
 
175 175
 \--::
176 176
 	Do not interpret any more arguments as options.
... ...
@@ -665,7 +665,7 @@ data by examining the beginning of the contents. However, sometimes you
665 665
 may want to override its decision, either because a blob contains binary
666 666
 data later in the file, or because the content, while technically
667 667
 composed of text characters, is opaque to a human reader. For example,
668
-many postscript files contain only ascii characters, but produce noisy
668
+many postscript files contain only ASCII characters, but produce noisy
669 669
 and meaningless diffs.
670 670
 
671 671
 The simplest way to mark a file as binary is to unset the diff
... ...
@@ -680,7 +680,7 @@ patch, if binary patches are enabled) instead of a regular diff.
680 680
 
681 681
 However, one may also want to specify other diff driver attributes. For
682 682
 example, you might want to use `textconv` to convert postscript files to
683
-an ascii representation for human viewing, but otherwise treat them as
683
+an ASCII representation for human viewing, but otherwise treat them as
684 684
 binary files. You cannot specify both `-diff` and `diff=ps` attributes.
685 685
 The solution is to use the `diff.*.binary` config option:
686 686
 
... ...
@@ -175,7 +175,7 @@ if the merge failed due to conflicts.
175 175
 
176 176
 This hook can be used in conjunction with a corresponding pre-commit hook to
177 177
 save and restore any form of metadata associated with the working tree
178
-(eg: permissions/ownership, ACLS, etc).  See contrib/hooks/setgitperms.perl
178
+(e.g.: permissions/ownership, ACLS, etc).  See contrib/hooks/setgitperms.perl
179 179
 for an example of how to do this.
180 180
 
181 181
 pre-push
... ...
@@ -329,7 +329,7 @@ short form, the leading colon `:` is followed by zero or more "magic
329 329
 signature" letters (which optionally is terminated by another colon `:`),
330 330
 and the remainder is the pattern to match against the path.
331 331
 The "magic signature" consists of ASCII symbols that are neither
332
-alphanumeric, glob, regex special charaters nor colon.
332
+alphanumeric, glob, regex special characters nor colon.
333 333
 The optional colon that terminates the "magic signature" can be
334 334
 omitted if the pattern begins with a character that does not belong to
335 335
 "magic signature" symbol set and is not a colon.
... ...
@@ -38,7 +38,7 @@ zlib were failing).
38 38
 Reading the zlib source code, I found that "incorrect data check" means
39 39
 that the adler-32 checksum at the end of the zlib data did not match the
40 40
 inflated data. So stepping the data through zlib would not help, as it
41
-did not fail until the very end, when we realize the crc does not match.
41
+did not fail until the very end, when we realize the CRC does not match.
42 42
 The problematic bytes could be anywhere in the object data.
43 43
 
44 44
 The first thing I did was pull the broken data out of the packfile. I
... ...
@@ -195,7 +195,7 @@ halfway through:
195 195
 -------
196 196
 
197 197
 I let it run to completion, and got a few more hits at the end (where it
198
-was munging the crc to match our broken data). So there was a good
198
+was munging the CRC to match our broken data). So there was a good
199 199
 chance this middle hit was the source of the problem.
200 200
 
201 201
 I confirmed by tweaking the byte in a hex editor, zlib inflating the
... ...
@@ -160,7 +160,7 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit).
160 160
 	consider. Repetitions of this option accumulate exclusion patterns
161 161
 	up to the next `--all`, `--branches`, `--tags`, `--remotes`, or
162 162
 	`--glob` option (other options or arguments do not clear
163
-	accumlated patterns).
163
+	accumulated patterns).
164 164
 +
165 165
 The patterns given should not begin with `refs/heads`, `refs/tags`, or
166 166
 `refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
... ...
@@ -231,5 +231,5 @@ Git index format
231 231
     on. Replaced entries may have empty path names to save space.
232 232
 
233 233
   The remaining index entries after replaced ones will be added to the
234
-  final index. These added entries are also sorted by entry namme then
234
+  final index. These added entries are also sorted by entry name then
235 235
   stage.
... ...
@@ -168,7 +168,7 @@ agent capability). The `X` and `Y` strings may contain any printable
168 168
 ASCII characters except space (i.e., the byte range 32 < x < 127), and
169 169
 are typically of the form "package/version" (e.g., "git/1.8.3.1"). The
170 170
 agent strings are purely informative for statistics and debugging
171
-purposes, and MUST NOT be used to programatically assume the presence
171
+purposes, and MUST NOT be used to programmatically assume the presence
172 172
 or absence of particular features.
173 173
 
174 174
 shallow
... ...
@@ -114,7 +114,7 @@ split::
114 114
 	want.
115 115
 	
116 116
 	Repeated splits of exactly the same history are
117
-	guaranteed to be identical (ie. to produce the same
117
+	guaranteed to be identical (i.e. to produce the same
118 118
 	commit ids).  Because of this, if you add new commits
119 119
 	and then re-split, the new commits will be attached as
120 120
 	commits on top of the history you generated last time,