documentation: fix subject/verb agreement
Diff best viewed with --color-diff. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Elijah Newren committed
Oct 8, 2023 at 06:45 UTC
ce14cc0b00098201f967346955804abd774174ea
25 files changed
+28
-28
Documentation/CodingGuidelines
+1
-1
@@ -40,7 +40,7 @@ As for more concrete guidelines, just imitate the existing code
40
contributing to). It is always preferable to match the _local_
41
convention. New code added to Git suite is expected to match
42
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
44
uses (even if it doesn't match the overall style of existing code).
45
46
But if you must have a list of rules, here are some language
Documentation/config/advice.txt
+1
-1
@@ -5,7 +5,7 @@ advice.*::
5
+
6
--
7
ambiguousFetchRefspec::
8
- Advice shown when fetch refspec for multiple remotes map to
8
+ Advice shown when fetch refspec for multiple remotes maps to
9
the same remote-tracking branch namespace and causes branch
10
tracking set-up to fail.
11
fetchShowForcedUpdates::
Documentation/config/alias.txt
+1
-1
@@ -4,7 +4,7 @@ alias.*::
4
`git last` is equivalent to `git cat-file commit HEAD`. To avoid
5
confusion and troubles with script usage, aliases that
6
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.
8
A quote pair or a backslash can be used to quote them.
9
+
10
Note that the first word of an alias does not necessarily have to be a
Documentation/config/fsck.txt
+1
-1
@@ -44,7 +44,7 @@ fsck.skipList::
44
The path to a list of object names (i.e. one unabbreviated SHA-1 per
45
line) that are known to be broken in a non-fatal way and should
46
be ignored. On versions of Git 2.20 and later comments ('#'), empty
47
- lines, and any leading and trailing whitespace is ignored. Everything
47
+ lines, and any leading and trailing whitespace are ignored. Everything
48
but a SHA-1 per line will error out on older versions.
49
+
50
This feature is useful when an established project should be accepted
Documentation/config/gpg.txt
+1
-1
@@ -25,7 +25,7 @@ gpg.<format>.program::
25
gpg.minTrustLevel::
26
Specifies a minimum trust level for signature verification. If
27
this option is unset, then signature verification for merge
28
- operations require a key with at least `marginal` trust. Other
28
+ operations requires a key with at least `marginal` trust. Other
29
operations that perform signature verification require a key
30
with at least `undefined` trust. Setting this option overrides
31
the required trust-level for all operations. Supported values,
Documentation/config/maintenance.txt
+1
-1
@@ -12,7 +12,7 @@ maintenance.strategy::
12
then that value is used instead of the one provided by
13
`maintenance.strategy`. The possible strategy strings are:
14
+
15
-* `none`: This default setting implies no task are run at any schedule.
15
+* `none`: This default setting implies no tasks are run at any schedule.
16
* `incremental`: This setting optimizes for performing small maintenance
17
activities that do not delete any data. This does not schedule the `gc`
18
task, but runs the `prefetch` and `commit-graph` tasks hourly, the
Documentation/config/status.txt
+1
-1
@@ -47,7 +47,7 @@ status.showUntrackedFiles::
47
contain only untracked files, are shown with the directory name
48
only. Showing untracked files means that Git needs to lstat() all
49
the files in the whole repository, which might be slow on some
50
- systems. So, this variable controls how the commands displays
50
+ systems. So, this variable controls how the commands display
51
the untracked files. Possible values are:
52
+
53
--
Documentation/fetch-options.txt
+1
-1
@@ -43,7 +43,7 @@ the current repository has the same history as the source repository.
43
--update-shallow::
44
By default when fetching from a shallow repository,
45
`git fetch` refuses refs that require updating
46
- .git/shallow. This option updates .git/shallow and accept such
46
+ .git/shallow. This option updates .git/shallow and accepts such
47
refs.
48
49
--negotiation-tip=<commit|glob>::
Documentation/git-blame.txt
+1
-1
@@ -128,7 +128,7 @@ at least once for each commit:
128
- the filename in the commit that the line is attributed to.
129
- the first line of the commit log message ("summary").
130
131
-The contents of the actual line is output after the above
131
+The contents of the actual line are output after the above
132
header, prefixed by a TAB. This is to allow adding more
133
header elements later.
134
Documentation/git-diff-tree.txt
+1
-1
@@ -107,7 +107,7 @@ include::pretty-options.txt[]
107
by omitting uninteresting hunks whose contents in the parents
108
have only two variants and the merge result picks one of them
109
without modification. When all hunks are uninteresting, the commit
110
- itself and the commit log message is not shown, just like in any other
110
+ itself and the commit log message are not shown, just like in any other
111
"empty diff" case.
112
113
--combined-all-paths::
Documentation/git-format-patch.txt
+1
-1
@@ -55,7 +55,7 @@ A "message" generated by the command consists of three parts:
55
* The "patch", which is the "diff -p --stat" output (see
56
linkgit:git-diff[1]) between the commit and its parent.
57
58
-The log message and the patch is separated by a line with a
58
+The log message and the patch are separated by a line with a
59
three-dash line.
60
61
There are two ways to specify which commits to operate on.
Documentation/git-fsck.txt
+2
-2
@@ -64,7 +64,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
64
--connectivity-only::
65
Check only the connectivity of reachable objects, making sure
66
that any objects referenced by a reachable tag, commit, or tree
67
- is present. This speeds up the operation by avoiding reading
67
+ are present. This speeds up the operation by avoiding reading
68
blobs entirely (though it does still check that referenced blobs
69
exist). This will detect corruption in commits and trees, but
70
not do any semantic checks (e.g., for format errors). Corruption
@@ -79,7 +79,7 @@ care about this output and want to speed it up further.
79
recorded with g+w bit set, which was created by older
80
versions of Git. Existing repositories, including the
81
Linux kernel, Git itself, and sparse repository have old
82
- objects that triggers this check, but it is recommended
82
+ objects that trigger this check, but it is recommended
83
to check new projects with this flag.
84
85
--verbose::
Documentation/git-init.txt
+1
-1
@@ -115,7 +115,7 @@ Same as 'group', but make the repository readable by all users.
115
'<perm>' is a 3-digit octal number prefixed with `0` and each file
116
will have mode '<perm>'. '<perm>' will override users' umask(2)
117
value (and not only loosen permissions as 'group' and 'all'
118
-does). '0640' will create a repository which is group-readable, but
118
+do). '0640' will create a repository which is group-readable, but
119
not group-writable or accessible to others. '0660' will create a repo
120
that is readable and writable to the current user and group, but
121
inaccessible to others (directories and executable files get their
Documentation/git-rev-list.txt
+1
-1
@@ -19,7 +19,7 @@ include::rev-list-description.txt[]
19
20
'rev-list' is an essential Git command, since it
21
provides the ability to build and traverse commit ancestry graphs. For
22
-this reason, it has a lot of different options that enables it to be
22
+this reason, it has a lot of different options that enable it to be
23
used by commands as different as 'git bisect' and
24
'git repack'.
25
Documentation/git-show-ref.txt
+1
-1
@@ -144,7 +144,7 @@ use:
144
-----------------------------------------------------------------------------
145
146
This will show "refs/heads/master" but also "refs/remote/other-repo/master",
147
-if such references exists.
147
+if such references exist.
148
149
When using the `--verify` flag, the command requires an exact path:
150
Documentation/git-symbolic-ref.txt
+1
-1
@@ -27,7 +27,7 @@ symbolic ref.
27
28
A symbolic ref is a regular file that stores a string that
29
begins with `ref: refs/`. For example, your `.git/HEAD` is
30
-a regular file whose contents is `ref: refs/heads/master`.
30
+a regular file whose content is `ref: refs/heads/master`.
31
32
OPTIONS
33
-------
Documentation/gitdiffcore.txt
+1
-1
@@ -173,7 +173,7 @@ Note that when rename detection is on but both copy and break
173
detection are off, rename detection adds a preliminary step that first
174
checks if files are moved across directories while keeping their
175
filename the same. If there is a file added to a directory whose
176
-contents is sufficiently similar to a file with the same name that got
176
+contents are sufficiently similar to a file with the same name that got
177
deleted from a different directory, it will mark them as renames and
178
exclude them from the later quadratic step (the one that pairwise
179
compares all unmatched files to find the "best" matches, determined by
Documentation/gitformat-bundle.txt
+1
-1
@@ -67,7 +67,7 @@ A Git bundle consists of several parts.
67
* "Capabilities", which are only in the v3 format, indicate functionality that
68
the bundle requires to be read properly.
69
70
-* "Prerequisites" lists the objects that are NOT included in the bundle and the
70
+* "Prerequisites" list the objects that are NOT included in the bundle and the
71
reader of the bundle MUST already have, in order to use the data in the
72
bundle. The objects stored in the bundle may refer to prerequisite objects and
73
anything reachable from them (e.g. a tree object in the bundle can reference
Documentation/gitprotocol-capabilities.txt
+1
-1
@@ -30,7 +30,7 @@ to be in effect. The client MUST NOT ask for capabilities the server
30
did not say it supports.
31
32
Server MUST diagnose and abort if capabilities it does not understand
33
-was sent. Server MUST NOT ignore capabilities that client requested
33
+were sent. Server MUST NOT ignore capabilities that client requested
34
and server advertised. As a consequence of these rules, server MUST
35
NOT advertise capabilities it does not understand.
36
Documentation/gitprotocol-pack.txt
+2
-2
@@ -30,7 +30,7 @@ pkt-line Format
30
---------------
31
32
The descriptions below build on the pkt-line format described in
33
-linkgit:gitprotocol-common[5]. When the grammar indicate `PKT-LINE(...)`, unless
33
+linkgit:gitprotocol-common[5]. When the grammar indicates `PKT-LINE(...)`, unless
34
otherwise noted the usual pkt-line LF rules apply: the sender SHOULD
35
include a LF, but the receiver MUST NOT complain if it is not present.
36
@@ -325,7 +325,7 @@ a positive depth, this step is skipped.
325
326
If the client has requested a positive depth, the server will compute
327
the set of commits which are no deeper than the desired depth. The set
328
-of commits start at the client's wants.
328
+of commits starts at the client's wants.
329
330
The server writes 'shallow' lines for each
331
commit whose parents will not be sent as a result. The server writes
Documentation/glossary-content.txt
+1
-1
@@ -186,7 +186,7 @@ current branch integrates with) obviously do not work, as there is no
186
points at the directory that is the real repository.
187
188
[[def_grafts]]grafts::
189
- Grafts enables two otherwise different lines of development to be joined
189
+ Grafts enable two otherwise different lines of development to be joined
190
together by recording fake ancestry information for commits. This way
191
you can make Git pretend the set of <<def_parent,parents>> a <<def_commit,commit>> has
192
is different from what was recorded when the commit was
Documentation/howto/coordinate-embargoed-releases.txt
+1
-1
@@ -145,7 +145,7 @@ Opening a Security Advisory draft
145
146
The first step is to https://github.com/git/git/security/advisories/new[open
147
an advisory]. Technically, this is not necessary. However, it is the most
148
-convenient way to obtain the CVE number and it give us a private repository
148
+convenient way to obtain the CVE number and it gives us a private repository
149
associated with it that can be used to collaborate on a fix.
150
151
Notifying the Linux distributions
Documentation/i18n.txt
+1
-1
@@ -34,7 +34,7 @@ project find it more convenient to use legacy encodings, Git
34
does not forbid it. However, there are a few things to keep in
35
mind.
36
37
-. 'git commit' and 'git commit-tree' issues
37
+. 'git commit' and 'git commit-tree' issue
38
a warning if the commit log message given to it does not look
39
like a valid UTF-8 string, unless you explicitly say your
40
project uses a legacy encoding. The way to say this is to
Documentation/technical/api-simple-ipc.txt
+1
-1
@@ -2,7 +2,7 @@ Simple-IPC API
2
==============
3
4
The Simple-IPC API is a collection of `ipc_` prefixed library routines
5
-and a basic communication protocol that allow an IPC-client process to
5
+and a basic communication protocol that allows an IPC-client process to
6
send an application-specific IPC-request message to an IPC-server
7
process and receive an application-specific IPC-response message.
8
Documentation/technical/reftable.txt
+2
-2
@@ -46,7 +46,7 @@ search lookup, and range scans.
46
47
Storage in the file is organized into variable sized blocks. Prefix
48
compression is used within a single block to reduce disk space. Block
49
-size and alignment is tunable by the writer.
49
+size and alignment are tunable by the writer.
50
51
Performance
52
^^^^^^^^^^^
@@ -288,7 +288,7 @@ The 2-byte `restart_count` stores the number of entries in the
288
`restart_count` to binary search between restarts before starting a
289
linear scan.
290
291
-Exactly `restart_count` 3-byte `restart_offset` values precedes the
291
+Exactly `restart_count` 3-byte `restart_offset` values precede the
292
`restart_count`. Offsets are relative to the start of the block and
293
refer to the first byte of any `ref_record` whose name has not been
294
prefix compressed. Entries in the `restart_offset` list must be sorted,