Skip to content

Commit d12166d

Browse files
committed
Merge branch 'en/docfixes'
Documentation typo and grammo fixes. * en/docfixes: (25 commits) documentation: add missing parenthesis documentation: add missing quotes documentation: add missing fullstops documentation: add some commas where they are helpful documentation: fix whitespace issues documentation: fix capitalization documentation: fix punctuation documentation: use clearer prepositions documentation: add missing hyphens documentation: remove unnecessary hyphens documentation: add missing article documentation: fix choice of article documentation: whitespace is already generally plural documentation: fix singular vs. plural documentation: fix verb vs. noun documentation: fix adjective vs. noun documentation: fix verb tense documentation: employ consistent verb tense for a list documentation: fix subject/verb agreement documentation: remove extraneous words ...
2 parents 5edbcea + 5fbcdb2 commit d12166d

File tree

171 files changed

+478
-477
lines changed

Some content is hidden

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

171 files changed

+478
-477
lines changed

Documentation/CodingGuidelines

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Like other projects, we also have some guidelines to keep to the
2-
code. For Git in general, a few rough rules are:
1+
Like other projects, we also have some guidelines for our code. For
2+
Git in general, a few rough rules are:
33

44
- Most importantly, we never say "It's in POSIX; we'll happily
55
ignore your needs should your system not conform to it."
@@ -40,7 +40,7 @@ As for more concrete guidelines, just imitate the existing code
4040
contributing to). It is always preferable to match the _local_
4141
convention. New code added to Git suite is expected to match
4242
the overall style of existing code. Modifications to existing
43-
code is expected to match the style the surrounding code already
43+
code are expected to match the style the surrounding code already
4444
uses (even if it doesn't match the overall style of existing code).
4545

4646
But if you must have a list of rules, here are some language

Documentation/ReviewingGuidelines.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Principles
1919
Selecting patch(es) to review
2020
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2121
If you are looking for a patch series in need of review, start by checking
22-
latest "What's cooking in git.git" email
22+
the latest "What's cooking in git.git" email
2323
(https://lore.kernel.org/git/[email protected]/[example]). The "What's
2424
cooking" emails & replies can be found using the query `s:"What's cooking"` on
2525
the https://lore.kernel.org/git/[`lore.kernel.org` mailing list archive];
@@ -126,7 +126,7 @@ Terminology
126126
-----------
127127
nit: ::
128128
Denotes a small issue that should be fixed, such as a typographical error
129-
or mis-alignment of conditions in an `if()` statement.
129+
or misalignment of conditions in an `if()` statement.
130130

131131
aside: ::
132132
optional: ::

Documentation/SubmittingPatches

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ maintainer.
8787
Under truly exceptional circumstances where you absolutely must depend
8888
on a select few topic branches that are already in `next` but not in
8989
`master`, you may want to create your own custom base-branch by forking
90-
`master` and merging the required topic branches to it. You could then
90+
`master` and merging the required topic branches into it. You could then
9191
work on top of this base-branch. But keep in mind that this base-branch
9292
would only be known privately to you. So when you are ready to send
9393
your patches to the list, be sure to communicate how you created it in

Documentation/ToolsForGit.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Tools for developing Git
55
[[summary]]
66
== Summary
77

8-
This document gathers tips, scripts and configuration file to help people
8+
This document gathers tips, scripts, and configuration files to help people
99
working on Git's codebase use their favorite tools while following Git's
1010
coding style.
1111

@@ -32,7 +32,7 @@ information on using the script.
3232

3333
This is adapted from Linux's suggestion in its CodingStyle document:
3434

35-
- To follow rules of the CodingGuideline, it's useful to put the following in
35+
- To follow the rules in CodingGuidelines, it's useful to put the following in
3636
GIT_CHECKOUT/.dir-locals.el, assuming you use cperl-mode:
3737
----
3838
;; note the first part is useful for C editing, too

Documentation/config.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ file. The file `/etc/gitconfig` can be used to store a system-wide
1111
default configuration.
1212

1313
The configuration variables are used by both the Git plumbing
14-
and the porcelains. The variables are divided into sections, wherein
14+
and the porcelain commands. The variables are divided into sections, wherein
1515
the fully qualified variable name of the variable itself is the last
1616
dot-separated segment and the section name is everything before the last
1717
dot. The variable names are case-insensitive, allow only alphanumeric
@@ -103,7 +103,7 @@ was found. See below for examples.
103103
Conditional includes
104104
~~~~~~~~~~~~~~~~~~~~
105105

106-
You can include a config file from another conditionally by setting a
106+
You can conditionally include a config file from another by setting an
107107
`includeIf.<condition>.path` variable to the name of the file to be
108108
included.
109109

@@ -118,7 +118,7 @@ are:
118118
pattern, the include condition is met.
119119
+
120120
The .git location may be auto-discovered, or come from `$GIT_DIR`
121-
environment variable. If the repository is auto discovered via a .git
121+
environment variable. If the repository is auto-discovered via a .git
122122
file (e.g. from submodules, or a linked worktree), the .git location
123123
would be the final location where the .git directory is, not where the
124124
.git file is.

Documentation/config/advice.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ advice.*::
55
+
66
--
77
ambiguousFetchRefspec::
8-
Advice shown when fetch refspec for multiple remotes map to
8+
Advice shown when a fetch refspec for multiple remotes maps to
99
the same remote-tracking branch namespace and causes branch
1010
tracking set-up to fail.
1111
fetchShowForcedUpdates::
@@ -63,7 +63,7 @@ advice.*::
6363
the template shown when writing commit messages in
6464
linkgit:git-commit[1], and in the help message shown
6565
by linkgit:git-switch[1] or
66-
linkgit:git-checkout[1] when switching branch.
66+
linkgit:git-checkout[1] when switching branches.
6767
statusUoption::
6868
Advise to consider using the `-u` option to linkgit:git-status[1]
6969
when the command takes more than 2 seconds to enumerate untracked
@@ -87,7 +87,7 @@ advice.*::
8787
detachedHead::
8888
Advice shown when you used
8989
linkgit:git-switch[1] or linkgit:git-checkout[1]
90-
to move to the detach HEAD state, to instruct how to
90+
to move to the detached HEAD state, to instruct how to
9191
create a local branch after the fact.
9292
suggestDetachingHead::
9393
Advice shown when linkgit:git-switch[1] refuses to detach HEAD
@@ -101,7 +101,7 @@ advice.*::
101101
otherwise caused a remote-tracking branch to be
102102
checked out. See the `checkout.defaultRemote`
103103
configuration variable for how to set a given remote
104-
to used by default in some situations where this
104+
to be used by default in some situations where this
105105
advice would be printed.
106106
amWorkDir::
107107
Advice that shows the location of the patch file when

Documentation/config/alias.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ alias.*::
44
`git last` is equivalent to `git cat-file commit HEAD`. To avoid
55
confusion and troubles with script usage, aliases that
66
hide existing Git commands are ignored. Arguments are split by
7-
spaces, the usual shell quoting and escaping is supported.
7+
spaces, the usual shell quoting and escaping are supported.
88
A quote pair or a backslash can be used to quote them.
99
+
1010
Note that the first word of an alias does not necessarily have to be a

Documentation/config/apply.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ apply.ignoreWhitespace::
22
When set to 'change', tells 'git apply' to ignore changes in
33
whitespace, in the same way as the `--ignore-space-change`
44
option.
5-
When set to one of: no, none, never, false tells 'git apply' to
5+
When set to one of: no, none, never, false, it tells 'git apply' to
66
respect all whitespace differences.
77
See linkgit:git-apply[1].
88

99
apply.whitespace::
10-
Tells 'git apply' how to handle whitespaces, in the same way
10+
Tells 'git apply' how to handle whitespace, in the same way
1111
as the `--whitespace` option. See linkgit:git-apply[1].

Documentation/config/branch.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ branch.sort::
3636

3737
branch.<name>.remote::
3838
When on branch <name>, it tells 'git fetch' and 'git push'
39-
which remote to fetch from/push to. The remote to push to
39+
which remote to fetch from or push to. The remote to push to
4040
may be overridden with `remote.pushDefault` (for all branches).
4141
The remote to push to, for the current branch, may be further
4242
overridden by `branch.<name>.pushRemote`. If no remote is
@@ -64,7 +64,7 @@ branch.<name>.merge::
6464
handled like the remote part of a refspec, and must match a
6565
ref which is fetched from the remote given by
6666
"branch.<name>.remote".
67-
The merge information is used by 'git pull' (which at first calls
67+
The merge information is used by 'git pull' (which first calls
6868
'git fetch') to lookup the default branch for merging. Without
6969
this option, 'git pull' defaults to merge the first refspec fetched.
7070
Specify multiple values to get an octopus merge.
@@ -99,5 +99,5 @@ for details).
9999
branch.<name>.description::
100100
Branch description, can be edited with
101101
`git branch --edit-description`. Branch description is
102-
automatically added in the format-patch cover letter or
102+
automatically added to the format-patch cover letter or
103103
request-pull summary.

Documentation/config/checkout.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ checkout.workers::
3030
all commands that perform checkout. E.g. checkout, clone, reset,
3131
sparse-checkout, etc.
3232
+
33-
Note: parallel checkout usually delivers better performance for repositories
33+
Note: Parallel checkout usually delivers better performance for repositories
3434
located on SSDs or over NFS. For repositories on spinning disks and/or machines
3535
with a small number of cores, the default sequential checkout often performs
3636
better. The size and compression level of a repository might also influence how
@@ -39,6 +39,6 @@ well the parallel version performs.
3939
checkout.thresholdForParallelism::
4040
When running parallel checkout with a small number of files, the cost
4141
of subprocess spawning and inter-process communication might outweigh
42-
the parallelization gains. This setting allows to define the minimum
42+
the parallelization gains. This setting allows you to define the minimum
4343
number of files for which parallel checkout should be attempted. The
4444
default is 100.

0 commit comments

Comments
 (0)