Skip to content

Commit

Permalink
Merge branch 'en/docfixes'
Browse files Browse the repository at this point in the history
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
  ...
  • Loading branch information
gitster committed Oct 23, 2023
2 parents 5edbcea + 5fbcdb2 commit d12166d
Show file tree
Hide file tree
Showing 171 changed files with 478 additions and 477 deletions.
6 changes: 3 additions & 3 deletions Documentation/CodingGuidelines
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Like other projects, we also have some guidelines to keep to the
code. For Git in general, a few rough rules are:
Like other projects, we also have some guidelines for our code. For
Git in general, a few rough rules are:

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

But if you must have a list of rules, here are some language
Expand Down
4 changes: 2 additions & 2 deletions Documentation/ReviewingGuidelines.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Principles
Selecting patch(es) to review
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you are looking for a patch series in need of review, start by checking
latest "What's cooking in git.git" email
the latest "What's cooking in git.git" email
(https://lore.kernel.org/git/[email protected]/[example]). The "What's
cooking" emails & replies can be found using the query `s:"What's cooking"` on
the https://lore.kernel.org/git/[`lore.kernel.org` mailing list archive];
Expand Down Expand Up @@ -126,7 +126,7 @@ Terminology
-----------
nit: ::
Denotes a small issue that should be fixed, such as a typographical error
or mis-alignment of conditions in an `if()` statement.
or misalignment of conditions in an `if()` statement.

aside: ::
optional: ::
Expand Down
2 changes: 1 addition & 1 deletion Documentation/SubmittingPatches
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ maintainer.
Under truly exceptional circumstances where you absolutely must depend
on a select few topic branches that are already in `next` but not in
`master`, you may want to create your own custom base-branch by forking
`master` and merging the required topic branches to it. You could then
`master` and merging the required topic branches into it. You could then
work on top of this base-branch. But keep in mind that this base-branch
would only be known privately to you. So when you are ready to send
your patches to the list, be sure to communicate how you created it in
Expand Down
4 changes: 2 additions & 2 deletions Documentation/ToolsForGit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Tools for developing Git
[[summary]]
== Summary

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

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

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

- To follow rules of the CodingGuideline, it's useful to put the following in
- To follow the rules in CodingGuidelines, it's useful to put the following in
GIT_CHECKOUT/.dir-locals.el, assuming you use cperl-mode:
----
;; note the first part is useful for C editing, too
Expand Down
6 changes: 3 additions & 3 deletions Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ file. The file `/etc/gitconfig` can be used to store a system-wide
default configuration.

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

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

Expand All @@ -118,7 +118,7 @@ are:
pattern, the include condition is met.
+
The .git location may be auto-discovered, or come from `$GIT_DIR`
environment variable. If the repository is auto discovered via a .git
environment variable. If the repository is auto-discovered via a .git
file (e.g. from submodules, or a linked worktree), the .git location
would be the final location where the .git directory is, not where the
.git file is.
Expand Down
8 changes: 4 additions & 4 deletions Documentation/config/advice.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ advice.*::
+
--
ambiguousFetchRefspec::
Advice shown when fetch refspec for multiple remotes map to
Advice shown when a fetch refspec for multiple remotes maps to
the same remote-tracking branch namespace and causes branch
tracking set-up to fail.
fetchShowForcedUpdates::
Expand Down Expand Up @@ -63,7 +63,7 @@ advice.*::
the template shown when writing commit messages in
linkgit:git-commit[1], and in the help message shown
by linkgit:git-switch[1] or
linkgit:git-checkout[1] when switching branch.
linkgit:git-checkout[1] when switching branches.
statusUoption::
Advise to consider using the `-u` option to linkgit:git-status[1]
when the command takes more than 2 seconds to enumerate untracked
Expand All @@ -87,7 +87,7 @@ advice.*::
detachedHead::
Advice shown when you used
linkgit:git-switch[1] or linkgit:git-checkout[1]
to move to the detach HEAD state, to instruct how to
to move to the detached HEAD state, to instruct how to
create a local branch after the fact.
suggestDetachingHead::
Advice shown when linkgit:git-switch[1] refuses to detach HEAD
Expand All @@ -101,7 +101,7 @@ advice.*::
otherwise caused a remote-tracking branch to be
checked out. See the `checkout.defaultRemote`
configuration variable for how to set a given remote
to used by default in some situations where this
to be used by default in some situations where this
advice would be printed.
amWorkDir::
Advice that shows the location of the patch file when
Expand Down
2 changes: 1 addition & 1 deletion Documentation/config/alias.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ alias.*::
`git last` is equivalent to `git cat-file commit HEAD`. To avoid
confusion and troubles with script usage, aliases that
hide existing Git commands are ignored. Arguments are split by
spaces, the usual shell quoting and escaping is supported.
spaces, the usual shell quoting and escaping are supported.
A quote pair or a backslash can be used to quote them.
+
Note that the first word of an alias does not necessarily have to be a
Expand Down
4 changes: 2 additions & 2 deletions Documentation/config/apply.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ apply.ignoreWhitespace::
When set to 'change', tells 'git apply' to ignore changes in
whitespace, in the same way as the `--ignore-space-change`
option.
When set to one of: no, none, never, false tells 'git apply' to
When set to one of: no, none, never, false, it tells 'git apply' to
respect all whitespace differences.
See linkgit:git-apply[1].

apply.whitespace::
Tells 'git apply' how to handle whitespaces, in the same way
Tells 'git apply' how to handle whitespace, in the same way
as the `--whitespace` option. See linkgit:git-apply[1].
6 changes: 3 additions & 3 deletions Documentation/config/branch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ branch.sort::

branch.<name>.remote::
When on branch <name>, it tells 'git fetch' and 'git push'
which remote to fetch from/push to. The remote to push to
which remote to fetch from or push to. The remote to push to
may be overridden with `remote.pushDefault` (for all branches).
The remote to push to, for the current branch, may be further
overridden by `branch.<name>.pushRemote`. If no remote is
Expand Down Expand Up @@ -64,7 +64,7 @@ branch.<name>.merge::
handled like the remote part of a refspec, and must match a
ref which is fetched from the remote given by
"branch.<name>.remote".
The merge information is used by 'git pull' (which at first calls
The merge information is used by 'git pull' (which first calls
'git fetch') to lookup the default branch for merging. Without
this option, 'git pull' defaults to merge the first refspec fetched.
Specify multiple values to get an octopus merge.
Expand Down Expand Up @@ -99,5 +99,5 @@ for details).
branch.<name>.description::
Branch description, can be edited with
`git branch --edit-description`. Branch description is
automatically added in the format-patch cover letter or
automatically added to the format-patch cover letter or
request-pull summary.
4 changes: 2 additions & 2 deletions Documentation/config/checkout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ checkout.workers::
all commands that perform checkout. E.g. checkout, clone, reset,
sparse-checkout, etc.
+
Note: parallel checkout usually delivers better performance for repositories
Note: Parallel checkout usually delivers better performance for repositories
located on SSDs or over NFS. For repositories on spinning disks and/or machines
with a small number of cores, the default sequential checkout often performs
better. The size and compression level of a repository might also influence how
Expand All @@ -39,6 +39,6 @@ well the parallel version performs.
checkout.thresholdForParallelism::
When running parallel checkout with a small number of files, the cost
of subprocess spawning and inter-process communication might outweigh
the parallelization gains. This setting allows to define the minimum
the parallelization gains. This setting allows you to define the minimum
number of files for which parallel checkout should be attempted. The
default is 100.
2 changes: 1 addition & 1 deletion Documentation/config/clean.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
clean.requireForce::
A boolean to make git-clean do nothing unless given -f,
-i or -n. Defaults to true.
-i, or -n. Defaults to true.
4 changes: 2 additions & 2 deletions Documentation/config/clone.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ clone.defaultRemoteName::
option to linkgit:git-clone[1].

clone.rejectShallow::
Reject to clone a repository if it is a shallow one, can be overridden by
passing option `--reject-shallow` in command line. See linkgit:git-clone[1]
Reject cloning a repository if it is a shallow one; this can be overridden by
passing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]

clone.filterSubmodules::
If a partial clone filter is provided (see `--filter` in
Expand Down
2 changes: 1 addition & 1 deletion Documentation/config/color.txt
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ color.grep.<slot>::
matching text in context lines
`matchSelected`;;
matching text in selected lines. Also, used to customize the following
linkgit:git-log[1] subcommands: `--grep`, `--author` and `--committer`.
linkgit:git-log[1] subcommands: `--grep`, `--author`, and `--committer`.
`selected`;;
non-matching text in selected lines. Also, used to customize the
following linkgit:git-log[1] subcommands: `--grep`, `--author` and
Expand Down
4 changes: 2 additions & 2 deletions Documentation/config/column.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ column.branch::
See `column.ui` for details.

column.clean::
Specify the layout when list items in `git clean -i`, which always
Specify the layout when listing items in `git clean -i`, which always
shows files and directories in columns. See `column.ui` for details.

column.status::
Specify whether to output untracked files in `git status` in columns.
See `column.ui` for details.

column.tag::
Specify whether to output tag listing in `git tag` in columns.
Specify whether to output tag listings in `git tag` in columns.
See `column.ui` for details.
4 changes: 2 additions & 2 deletions Documentation/config/commit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ commit.cleanup::
This setting overrides the default of the `--cleanup` option in
`git commit`. See linkgit:git-commit[1] for details. Changing the
default can be useful when you always want to keep lines that begin
with comment character `#` in your log message, in which case you
with the comment character `#` in your log message, in which case you
would do `git config commit.cleanup whitespace` (note that you will
have to remove the help lines that begin with `#` in the commit log
template yourself, if you do this).
Expand All @@ -25,5 +25,5 @@ commit.template::
new commit messages.

commit.verbose::
A boolean or int to specify the level of verbose with `git commit`.
A boolean or int to specify the level of verbosity with `git commit`.
See linkgit:git-commit[1].
4 changes: 2 additions & 2 deletions Documentation/config/credential.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ credential.username::

credential.<url>.*::
Any of the credential.* options above can be applied selectively to
some credentials. For example "credential.https://example.com.username"
some credentials. For example, "credential.https://example.com.username"
would set the default username only for https connections to
example.com. See linkgit:gitcredentials[7] for details on how URLs are
matched.
Expand All @@ -31,6 +31,6 @@ credentialCache.ignoreSIGHUP::

credentialStore.lockTimeoutMS::
The length of time, in milliseconds, for git-credential-store to retry
when trying to lock the credentials file. Value 0 means not to retry at
when trying to lock the credentials file. A value of 0 means not to retry at
all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
1s).
2 changes: 1 addition & 1 deletion Documentation/config/diff.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
diff.autoRefreshIndex::
When using 'git diff' to compare with work tree
files, do not consider stat-only change as changed.
files, do not consider stat-only changes as changed.
Instead, silently run `git update-index --refresh` to
update the cached stat information for paths whose
contents in the work tree match the contents in the
Expand Down
4 changes: 2 additions & 2 deletions Documentation/config/fastimport.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
fastimport.unpackLimit::
If the number of objects imported by linkgit:git-fast-import[1]
is below this limit, then the objects will be unpacked into
loose object files. However if the number of imported objects
equals or exceeds this limit then the pack will be stored as a
loose object files. However, if the number of imported objects
equals or exceeds this limit, then the pack will be stored as a
pack. Storing the pack from a fast-import can make the import
operation complete faster, especially on slow filesystems. If
not set, the value of `transfer.unpackLimit` is used instead.
4 changes: 2 additions & 2 deletions Documentation/config/fetch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ fetch.pruneTags::

fetch.output::
Control how ref update status is printed. Valid values are
`full` and `compact`. Default value is `full`. See section
OUTPUT in linkgit:git-fetch[1] for detail.
`full` and `compact`. Default value is `full`. See the
OUTPUT section in linkgit:git-fetch[1] for details.

fetch.negotiationAlgorithm::
Control how information about the commits in the local repository
Expand Down
2 changes: 1 addition & 1 deletion Documentation/config/format.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ format.encodeEmailHeaders::
Defaults to true.

format.pretty::
The default pretty format for log/show/whatchanged command,
The default pretty format for log/show/whatchanged command.
See linkgit:git-log[1], linkgit:git-show[1],
linkgit:git-whatchanged[1].

Expand Down
22 changes: 11 additions & 11 deletions Documentation/config/fsck.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ to clone or fetch it set `fetch.fsck.<msg-id>`.
+
The rest of the documentation discusses `fsck.*` for brevity, but the
same applies for the corresponding `receive.fsck.*` and
`fetch.<msg-id>.*`. variables.
`fetch.fsck.*`. variables.
+
Unlike variables like `color.ui` and `core.editor` the
Unlike variables like `color.ui` and `core.editor`, the
`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
fall back on the `fsck.<msg-id>` configuration if they aren't set. To
uniformly configure the same fsck settings in different circumstances
all three of them they must all set to the same values.
uniformly configure the same fsck settings in different circumstances,
all three of them must be set to the same values.
+
When `fsck.<msg-id>` is set, errors can be switched to warnings and
vice versa by configuring the `fsck.<msg-id>` setting where the
Expand All @@ -36,19 +36,19 @@ Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
will only cause git to warn.
+
See `Fsck Messages` section of linkgit:git-fsck[1] for supported
See the `Fsck Messages` section of linkgit:git-fsck[1] for supported
values of `<msg-id>`.


fsck.skipList::
The path to a list of object names (i.e. one unabbreviated SHA-1 per
line) that are known to be broken in a non-fatal way and should
be ignored. On versions of Git 2.20 and later comments ('#'), empty
lines, and any leading and trailing whitespace is ignored. Everything
be ignored. On versions of Git 2.20 and later, comments ('#'), empty
lines, and any leading and trailing whitespace are ignored. Everything
but a SHA-1 per line will error out on older versions.
+
This feature is useful when an established project should be accepted
despite early commits containing errors that can be safely ignored
despite early commits containing errors that can be safely ignored,
such as invalid committer email addresses. Note: corrupt objects
cannot be skipped with this setting.
+
Expand All @@ -58,11 +58,11 @@ Like `fsck.<msg-id>` this variable has corresponding
Unlike variables like `color.ui` and `core.editor` the
`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
fall back on the `fsck.skipList` configuration if they aren't set. To
uniformly configure the same fsck settings in different circumstances
all three of them they must all set to the same values.
uniformly configure the same fsck settings in different circumstances,
all three of them must be set to the same values.
+
Older versions of Git (before 2.20) documented that the object names
list should be sorted. This was never a requirement, the object names
list should be sorted. This was never a requirement; the object names
could appear in any order, but when reading the list we tracked whether
the list was sorted for the purposes of an internal binary search
implementation, which could save itself some work with an already sorted
Expand Down
2 changes: 1 addition & 1 deletion Documentation/config/fsmonitor--daemon.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
fsmonitor.allowRemote::
By default, the fsmonitor daemon refuses to work against network-mounted
By default, the fsmonitor daemon refuses to work with network-mounted
repositories. Setting `fsmonitor.allowRemote` to `true` overrides this
behavior. Only respected when `core.fsmonitor` is set to `true`.

Expand Down
4 changes: 2 additions & 2 deletions Documentation/config/gc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ gc.auto::
default value is 6700.
+
Setting this to 0 disables not only automatic packing based on the
number of loose objects, but any other heuristic `git gc --auto` will
number of loose objects, but also any other heuristic `git gc --auto` will
otherwise use to determine if there's work to do, such as
`gc.autoPackLimit`.

Expand All @@ -39,7 +39,7 @@ See the `gc.bigPackThreshold` configuration variable below. When in
use, it'll affect how the auto pack limit works.

gc.autoDetach::
Make `git gc --auto` return immediately and run in background
Make `git gc --auto` return immediately and run in the background
if the system supports it. Default is true.

gc.bigPackThreshold::
Expand Down
Loading

0 comments on commit d12166d

Please sign in to comment.