documentation: wording improvements
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
cf6cac20059123d6ec3f867bb3692df62db52cf9
74 files changed
+134
-133
Documentation/CodingGuidelines
+2
-2
@@ -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:
3
4
- Most importantly, we never say "It's in POSIX; we'll happily
5
ignore your needs should your system not conform to it."
Documentation/ToolsForGit.txt
+1
-1
@@ -32,7 +32,7 @@ information on using the script.
32
33
This is adapted from Linux's suggestion in its CodingStyle document:
34
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
36
GIT_CHECKOUT/.dir-locals.el, assuming you use cperl-mode:
37
----
38
;; note the first part is useful for C editing, too
Documentation/config.txt
+2
-2
@@ -11,7 +11,7 @@ file. The file `/etc/gitconfig` can be used to store a system-wide
11
default configuration.
12
13
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
15
the fully qualified variable name of the variable itself is the last
16
dot-separated segment and the section name is everything before the last
17
dot. The variable names are case-insensitive, allow only alphanumeric
@@ -103,7 +103,7 @@ was found. See below for examples.
103
Conditional includes
104
~~~~~~~~~~~~~~~~~~~~
105
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 a
107
`includeIf.<condition>.path` variable to the name of the file to be
108
included.
109
Documentation/config/apply.txt
+1
-1
@@ -2,7 +2,7 @@ apply.ignoreWhitespace::
2
When set to 'change', tells 'git apply' to ignore changes in
3
whitespace, in the same way as the `--ignore-space-change`
4
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
6
respect all whitespace differences.
7
See linkgit:git-apply[1].
8
Documentation/config/branch.txt
+1
-1
@@ -36,7 +36,7 @@ branch.sort::
36
37
branch.<name>.remote::
38
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
40
may be overridden with `remote.pushDefault` (for all branches).
41
The remote to push to, for the current branch, may be further
42
overridden by `branch.<name>.pushRemote`. If no remote is
Documentation/config/clone.txt
+2
-2
@@ -4,8 +4,8 @@ clone.defaultRemoteName::
4
option to linkgit:git-clone[1].
5
6
clone.rejectShallow::
7
- Reject to clone a repository if it is a shallow one, can be overridden by
8
- passing option `--reject-shallow` in command line. See linkgit:git-clone[1]
7
+ Reject to clone a repository if it is a shallow one; this can be overridden by
8
+ passing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]
9
10
clone.filterSubmodules::
11
If a partial clone filter is provided (see `--filter` in
Documentation/config/credential.txt
+1
-1
@@ -31,6 +31,6 @@ credentialCache.ignoreSIGHUP::
31
32
credentialStore.lockTimeoutMS::
33
The length of time, in milliseconds, for git-credential-store to retry
34
- when trying to lock the credentials file. Value 0 means not to retry at
34
+ when trying to lock the credentials file. A value of 0 means not to retry at
35
all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
36
1s).
Documentation/config/fetch.txt
+2
-2
@@ -52,8 +52,8 @@ fetch.pruneTags::
52
53
fetch.output::
54
Control how ref update status is printed. Valid values are
55
- `full` and `compact`. Default value is `full`. See section
56
- OUTPUT in linkgit:git-fetch[1] for detail.
55
+ `full` and `compact`. Default value is `full`. See the
56
+ OUTPUT section in linkgit:git-fetch[1] for detail.
57
58
fetch.negotiationAlgorithm::
59
Control how information about the commits in the local repository
Documentation/config/fsck.txt
+2
-2
@@ -17,7 +17,7 @@ Unlike variables like `color.ui` and `core.editor` the
17
`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
18
fall back on the `fsck.<msg-id>` configuration if they aren't set. To
19
uniformly configure the same fsck settings in different circumstances
20
-all three of them they must all set to the same values.
20
+all three of them must be set to the same values.
21
+
22
When `fsck.<msg-id>` is set, errors can be switched to warnings and
23
vice versa by configuring the `fsck.<msg-id>` setting where the
@@ -59,7 +59,7 @@ Unlike variables like `color.ui` and `core.editor` the
59
`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
60
fall back on the `fsck.skipList` configuration if they aren't set. To
61
uniformly configure the same fsck settings in different circumstances
62
-all three of them they must all set to the same values.
62
+all three of them must be set to the same values.
63
+
64
Older versions of Git (before 2.20) documented that the object names
65
list should be sorted. This was never a requirement, the object names
Documentation/config/fsmonitor--daemon.txt
+1
-1
@@ -1,5 +1,5 @@
1
fsmonitor.allowRemote::
2
- By default, the fsmonitor daemon refuses to work against network-mounted
2
+ By default, the fsmonitor daemon refuses to work with network-mounted
3
repositories. Setting `fsmonitor.allowRemote` to `true` overrides this
4
behavior. Only respected when `core.fsmonitor` is set to `true`.
5
Documentation/config/gc.txt
+1
-1
@@ -24,7 +24,7 @@ gc.auto::
24
default value is 6700.
25
+
26
Setting this to 0 disables not only automatic packing based on the
27
-number of loose objects, but any other heuristic `git gc --auto` will
27
+number of loose objects, but also any other heuristic `git gc --auto` will
28
otherwise use to determine if there's work to do, such as
29
`gc.autoPackLimit`.
30
Documentation/config/gpg.txt
+1
-1
@@ -4,7 +4,7 @@ gpg.program::
4
same command-line interface as GPG, namely, to verify a detached
5
signature, "`gpg --verify $signature - <$file`" is run, and the
6
program is expected to signal a good signature by exiting with
7
- code 0, and to generate an ASCII-armored detached signature, the
7
+ code 0. To generate an ASCII-armored detached signature, the
8
standard input of "`gpg -bsau $key`" is fed with the contents to be
9
signed, and the program is expected to send the result to its
10
standard output.
Documentation/config/http.txt
+1
-1
@@ -260,7 +260,7 @@ http.noEPSV::
260
261
http.userAgent::
262
The HTTP USER_AGENT string presented to an HTTP server. The default
263
- value represents the version of the client Git such as git/1.7.1.
263
+ value represents the version of the Git client such as git/1.7.1.
264
This option allows you to override this value to a more common value
265
such as Mozilla/4.0. This may be necessary, for instance, if
266
connecting through a firewall that restricts HTTP connections to a set
Documentation/config/imap.txt
+1
-1
@@ -37,7 +37,7 @@ imap.preformattedHTML::
37
format=fixed email. Default is `false`.
38
39
imap.authMethod::
40
- Specify authenticate method for authentication with IMAP server.
40
+ Specify the authentication method for authenticating with the IMAP server.
41
If Git was built with the NO_CURL option, or if your curl version is older
42
than 7.34.0, or if you're running git-imap-send with the `--no-curl`
43
option, the only supported method is 'CRAM-MD5'. If this is not set
Documentation/config/mergetool.txt
+1
-1
@@ -47,7 +47,7 @@ mergetool.meld.useAutoMerge::
47
48
mergetool.vimdiff.layout::
49
The vimdiff backend uses this variable to control how its split
50
- windows look like. Applies even if you are using Neovim (`nvim`) or
50
+ windows appear. Applies even if you are using Neovim (`nvim`) or
51
gVim (`gvim`) as the merge tool. See BACKEND SPECIFIC HINTS section
52
ifndef::git-mergetool[]
53
in linkgit:git-mergetool[1].
Documentation/config/pack.txt
+3
-3
@@ -83,7 +83,7 @@ pack.indexVersion::
83
the new pack index with capabilities for packs larger than 4 GB
84
as well as proper protection against the repacking of corrupted
85
packs. Version 2 is the default. Note that version 2 is enforced
86
- and this config option ignored whenever the corresponding pack is
86
+ and this config option is ignored whenever the corresponding pack is
87
larger than 2 GB.
88
+
89
If you have an old Git that does not understand the version 2 `*.idx` file,
@@ -102,8 +102,8 @@ pack.packSizeLimit::
102
in the creation of multiple packfiles.
103
+
104
Note that this option is rarely useful, and may result in a larger total
105
-on-disk size (because Git will not store deltas between packs), as well
106
-as worse runtime performance (object lookup within multiple packs is
105
+on-disk size (because Git will not store deltas between packs) and
106
+worse runtime performance (object lookup within multiple packs is
107
slower than a single pack, and optimizations like reachability bitmaps
108
cannot cope with multiple packs).
109
+
Documentation/config/receive.txt
+1
-1
@@ -19,7 +19,7 @@ receive.certNonceSeed::
19
key.
20
21
receive.certNonceSlop::
22
- When a `git push --signed` sent a push certificate with a
22
+ When a `git push --signed` sends a push certificate with a
23
"nonce" that was issued by a receive-pack serving the same
24
repository within this many seconds, export the "nonce"
25
found in the certificate to `GIT_PUSH_CERT_NONCE` to the
Documentation/config/safe.txt
+2
-2
@@ -14,7 +14,7 @@ repository that contains a bare repository and running a Git command
14
within that directory.
15
+
16
This config setting is only respected in protected configuration (see
17
-<<SCOPES>>). This prevents the untrusted repository from tampering with
17
+<<SCOPES>>). This prevents untrusted repositories from tampering with
18
this value.
19
20
safe.directory::
@@ -32,7 +32,7 @@ override any such directories specified in the system config), add a
32
`safe.directory` entry with an empty value.
33
+
34
This config setting is only respected in protected configuration (see
35
-<<SCOPES>>). This prevents the untrusted repository from tampering with this
35
+<<SCOPES>>). This prevents untrusted repositories from tampering with this
36
value.
37
+
38
The value of this setting is interpolated, i.e. `~/<path>` expands to a
Documentation/config/submodule.txt
+1
-1
@@ -2,7 +2,7 @@ submodule.<name>.url::
2
The URL for a submodule. This variable is copied from the .gitmodules
3
file to the git config via 'git submodule init'. The user can change
4
the configured URL before obtaining the submodule via 'git submodule
5
- update'. If neither submodule.<name>.active or submodule.active are
5
+ update'. If neither submodule.<name>.active nor submodule.active are
6
set, the presence of this variable is used as a fallback to indicate
7
whether the submodule is of interest to git commands.
8
See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
Documentation/config/trace2.txt
+1
-1
@@ -66,6 +66,6 @@ trace2.destinationDebug::
66
67
trace2.maxFiles::
68
Integer. When writing trace files to a target directory, do not
69
- write additional traces if we would exceed this many files. Instead,
69
+ write additional traces if doing so would exceed this many files. Instead,
70
write a sentinel file that will block further tracing to this
71
directory. Defaults to 0, which disables this check.
Documentation/config/transfer.txt
+2
-2
@@ -7,7 +7,7 @@ transfer.credentialsInUrl::
7
and any other direct use of the configured URL.
8
+
9
Note that this is currently limited to detecting credentials in
10
-`remote.<name>.url` configuration, it won't detect credentials in
10
+`remote.<name>.url` configuration; it won't detect credentials in
11
`remote.<name>.pushurl` configuration.
12
+
13
You might want to enable this to prevent inadvertent credentials
@@ -26,7 +26,7 @@ exposure, e.g. because:
26
documented in procfs(5) allows for configuring this behavior.
27
+
28
If such concerns don't apply to you then you probably don't need to be
29
-concerned about credentials exposure due to storing that sensitive
29
+concerned about credentials exposure due to storing sensitive
30
data in git's configuration files. If you do want to use this, set
31
`transfer.credentialsInUrl` to one of these values:
32
+
Documentation/config/user.txt
+1
-1
@@ -10,7 +10,7 @@ committer.email::
10
If you need the `author` or `committer` to be different, the
11
`author.name`, `author.email`, `committer.name` or
12
`committer.email` variables can be set.
13
- Also, all of these can be overridden by the `GIT_AUTHOR_NAME`,
13
+ All of these can be overridden by the `GIT_AUTHOR_NAME`,
14
`GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
15
`GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
16
+
Documentation/diff-generate-patch.txt
+2
-2
@@ -146,7 +146,7 @@ information about detected contents movement (renames and
146
copying detection) are designed to work with diff of two
147
<tree-ish> and are not used by combined diff format.
148
149
-3. It is followed by two-line from-file/to-file header
149
+3. It is followed by a two-line from-file/to-file header:
150
151
--- a/file
152
+++ b/file
@@ -157,7 +157,7 @@ files.
157
+
158
However, if the --combined-all-paths option is provided, instead of a
159
two-line from-file/to-file you get a N+1 line from-file/to-file header,
160
-where N is the number of parents in the merge commit
160
+where N is the number of parents in the merge commit:
161
162
--- a/file
163
--- a/file
Documentation/diff-options.txt
+1
-1
@@ -733,7 +733,7 @@ matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
733
--rotate-to=<file>::
734
Discard the files before the named <file> from the output
735
(i.e. 'skip to'), or move them to the end of the output
736
- (i.e. 'rotate to'). These were invented primarily for use
736
+ (i.e. 'rotate to'). These options were invented primarily for the use
737
of the `git difftool` command, and may not be very useful
738
otherwise.
739
Documentation/git-apply.txt
+1
-1
@@ -159,7 +159,7 @@ discouraged.
159
160
--allow-binary-replacement::
161
--binary::
162
- Historically we did not allow binary patch applied
162
+ Historically we did not allow binary patch application
163
without an explicit permission from the user, and this
164
flag was the way to do so. Currently we always allow binary
165
patch application, so this is a no-op.
Documentation/git-archive.txt
+8
-8
@@ -21,14 +21,14 @@ structure for the named tree, and writes it out to the standard
21
output. If <prefix> is specified it is
22
prepended to the filenames in the archive.
23
24
-'git archive' behaves differently when given a tree ID versus when
25
-given a commit ID or tag ID. In the first case the current time is
26
-used as the modification time of each file in the archive. In the latter
27
-case the commit time as recorded in the referenced commit object is
28
-used instead. Additionally the commit ID is stored in a global
29
-extended pax header if the tar format is used; it can be extracted
30
-using 'git get-tar-commit-id'. In ZIP files it is stored as a file
31
-comment.
24
+'git archive' behaves differently when given a tree ID as opposed to a
25
+commit ID or tag ID. When a tree ID is provided, the current time is
26
+used as the modification time of each file in the archive. On the
27
+other hand, when a commit ID or tag ID is provided, the commit time as
28
+recorded in the referenced commit object is used instead.
29
+Additionally the commit ID is stored in a global extended pax header
30
+if the tar format is used; it can be extracted using 'git
31
+get-tar-commit-id'. In ZIP files it is stored as a file comment.
32
33
OPTIONS
34
-------
Documentation/git-bugreport.txt
+5
-4
@@ -13,10 +13,11 @@ SYNOPSIS
13
14
DESCRIPTION
15
-----------
16
-Captures information about the user's machine, Git client, and repository state,
17
-as well as a form requesting information about the behavior the user observed,
18
-into a single text file which the user can then share, for example to the Git
19
-mailing list, in order to report an observed bug.
16
+Collects information about the user's machine, Git client, and repository
17
+state, in addition to a form requesting information about the behavior the
18
+user observed, and stores it in a single text file which the user can then
19
+share, for example to the Git mailing list, in order to report an observed
20
+bug.
21
22
The following information is requested from the user:
23
Documentation/git-checkout-index.txt
+1
-1
@@ -18,7 +18,7 @@ SYNOPSIS
18
19
DESCRIPTION
20
-----------
21
-Will copy all files listed from the index to the working directory
21
+Copies all listed files from the index to the working directory
22
(not overwriting existing files).
23
24
OPTIONS
Documentation/git-count-objects.txt
+2
-2
@@ -12,7 +12,7 @@ SYNOPSIS
12
13
DESCRIPTION
14
-----------
15
-This counts the number of unpacked object files and disk space consumed by
15
+Counts the number of unpacked object files and disk space consumed by
16
them, to help you decide when it is a good time to repack.
17
18
@@ -20,7 +20,7 @@ OPTIONS
20
-------
21
-v::
22
--verbose::
23
- Report in more detail:
23
+ Provide more detailed reports:
24
+
25
count: the number of loose objects
26
+
Documentation/git-credential.txt
+1
-1
@@ -94,7 +94,7 @@ unlocked) before it returned `password=secr3t`.
94
that `git credential` will ask for a new password in its next
95
invocation. In either case, `git credential` should be fed with
96
the credential description obtained from step (2) (which also
97
- contain the ones provided in step (1)).
97
+ contains the fields provided in step (1)).
98
99
[[IOFMT]]
100
INPUT/OUTPUT FORMAT
Documentation/git-diff-index.txt
+2
-2
@@ -13,10 +13,10 @@ SYNOPSIS
13
14
DESCRIPTION
15
-----------
16
-Compares the content and mode of the blobs found in a tree object
16
+Compare the content and mode of the blobs found in a tree object
17
with the corresponding tracked files in the working tree, or with the
18
corresponding paths in the index. When <path> arguments are present,
19
-compares only paths matching those patterns. Otherwise all tracked
19
+compare only paths matching those patterns. Otherwise all tracked
20
files are compared.
21
22
OPTIONS
Documentation/git-diff-tree.txt
+1
-1
@@ -15,7 +15,7 @@ SYNOPSIS
15
16
DESCRIPTION
17
-----------
18
-Compares the content and mode of the blobs found via two tree objects.
18
+Compare the content and mode of blobs found via two tree objects.
19
20
If there is only one <tree-ish> given, the commit is compared with its parents
21
(see --stdin below).
Documentation/git-fast-import.txt
+1
-1
@@ -622,7 +622,7 @@ in octal. Git only supports the following modes:
622
* `100755` or `755`: A normal, but executable, file.
623
* `120000`: A symlink, the content of the file will be the link target.
624
* `160000`: A gitlink, SHA-1 of the object refers to a commit in
625
- another repository. Git links can only be specified by SHA or through
625
+ another repository. Git links can only be specified either by SHA or through
626
a commit mark. They are used to implement submodules.
627
* `040000`: A subdirectory. Subdirectories can only be specified by
628
SHA or through a tree mark set with `--import-marks`.
Documentation/git-hash-object.txt
+4
-4
@@ -39,10 +39,10 @@ OPTIONS
39
of from the command-line.
40
41
--path::
42
- Hash object as it were located at the given path. The location of
43
- file does not directly influence on the hash value, but path is
44
- used to determine what Git filters should be applied to the object
45
- before it can be placed to the object database, and, as result of
42
+ Hash object as if it were located at the given path. The location of
43
+ the file does not directly influence the hash value, but the path is
44
+ used to determine which Git filters should be applied to the object
45
+ before it can be placed in the object database. As a result of
46
applying filters, the actual blob put into the object database may
47
differ from the given file. This option is mainly useful for hashing
48
temporary files located outside of the working directory or files
Documentation/git-help.txt
+1
-1
@@ -109,7 +109,7 @@ other display programs (see below).
109
format. A web browser will be used for that purpose.
110
+
111
The web browser can be specified using the configuration variable
112
-`help.browser`, or `web.browser` if the former is not set. If none of
112
+`help.browser`, or `web.browser` if the former is not set. If neither of
113
these config variables is set, the 'git web{litdd}browse' helper script
114
(called by 'git help') will pick a suitable default. See
115
linkgit:git-web{litdd}browse[1] for more information about this.
Documentation/git-http-backend.txt
+5
-5
@@ -23,7 +23,7 @@ discussion of `GIT_PROTOCOL` in the ENVIRONMENT section below.
23
It verifies that the directory has the magic file
24
"git-daemon-export-ok", and it will refuse to export any Git directory
25
that hasn't explicitly been marked for export this way (unless the
26
-`GIT_HTTP_EXPORT_ALL` environmental variable is set).
26
+`GIT_HTTP_EXPORT_ALL` environment variable is set).
27
28
By default, only the `upload-pack` service is enabled, which serves
29
'git fetch-pack' and 'git ls-remote' clients, which are invoked from
@@ -42,12 +42,12 @@ http.getanyfile::
42
any file within the repository, including objects that are
43
no longer reachable from a branch but are still present.
44
It is enabled by default, but a repository can disable it
45
- by setting this configuration item to `false`.
45
+ by setting this configuration value to `false`.
46
47
http.uploadpack::
48
This serves 'git fetch-pack' and 'git ls-remote' clients.
49
It is enabled by default, but a repository can disable it
50
- by setting this configuration item to `false`.
50
+ by setting this configuration value to `false`.
51
52
http.receivepack::
53
This serves 'git send-pack' clients, allowing push. It is
@@ -265,12 +265,12 @@ by the invoking web server, including:
265
* QUERY_STRING
266
* REQUEST_METHOD
267
268
-The `GIT_HTTP_EXPORT_ALL` environmental variable may be passed to
268
+The `GIT_HTTP_EXPORT_ALL` environment variable may be passed to
269
'git-http-backend' to bypass the check for the "git-daemon-export-ok"
270
file in each repository before allowing export of that repository.
271
272
The `GIT_HTTP_MAX_REQUEST_BUFFER` environment variable (or the
273
-`http.maxRequestBuffer` config variable) may be set to change the
273
+`http.maxRequestBuffer` config option) may be set to change the
274
largest ref negotiation request that git will handle during a fetch; any
275
fetch requiring a larger buffer will not succeed. This value should not
276
normally need to be changed, but may be helpful if you are fetching from
Documentation/git-http-fetch.txt
+1
-1
@@ -31,7 +31,7 @@ commit-id::
31
Report what is downloaded.
32
33
-w <filename>::
34
- Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on
34
+ Writes the commit-id into the specified filename under $GIT_DIR/refs/<filename> on
35
the local end after the transfer is complete.
36
37
--stdin::
Documentation/git-http-push.txt
+2
-2
@@ -83,8 +83,8 @@ and where it is pushed is determined by using the destination side.
83
Without `--force`, the <src> ref is stored at the remote only if
84
<dst> does not exist, or <dst> is a proper subset (i.e. an
85
ancestor) of <src>. This check, known as "fast-forward check",
86
-is performed in order to avoid accidentally overwriting the
87
-remote ref and lose other peoples' commits from there.
86
+is performed to avoid accidentally overwriting the
87
+remote ref and losing other peoples' commits from there.
88
89
With `--force`, the fast-forward check is disabled for all refs.
90
Documentation/git-index-pack.txt
+5
-5
@@ -16,10 +16,10 @@ SYNOPSIS
16
17
DESCRIPTION
18
-----------
19
-Reads a packed archive (.pack) from the specified file, and
20
-builds a pack index file (.idx) for it. Optionally writes a
19
+Reads a packed archive (.pack) from the specified file,
20
+builds a pack index file (.idx) for it, and optionally writes a
21
reverse-index (.rev) for the specified pack. The packed
22
-archive together with the pack index can then be placed in
22
+archive, together with the pack index, can then be placed in
23
the objects/pack/ directory of a Git repository.
24
25
@@ -68,8 +68,8 @@ OPTIONS
68
updated to use objects contained in the pack.
69
70
--keep=<msg>::
71
- Like --keep create a .keep file before moving the index into
72
- its final destination, but rather than creating an empty file
71
+ Like --keep, create a .keep file before moving the index into
72
+ its final destination. However, instead of creating an empty file
73
place '<msg>' followed by an LF into the .keep file. The '<msg>'
74
message can later be searched for within all .keep files to
75
locate any which have outlived their usefulness.
Documentation/git-init.txt
+1
-1
@@ -99,7 +99,7 @@ specified.
99
100
'group' (or 'true')::
101
102
-Make the repository group-writable, (and g+sx, since the git group may be not
102
+Make the repository group-writable, (and g+sx, since the git group may not be
103
the primary group of all users). This is used to loosen the permissions of an
104
otherwise safe umask(2) value. Note that the umask still applies to the other
105
permission bits (e.g. if umask is '0022', using 'group' will not remove read
Documentation/git-ls-files.txt
+3
-3
@@ -25,12 +25,12 @@ SYNOPSIS
25
26
DESCRIPTION
27
-----------
28
-This merges the file listing in the index with the actual working
28
+This command merges the file listing in the index with the actual working
29
directory list, and shows different combinations of the two.
30
31
-One or more of the options below may be used to determine the files
31
+Several flags can be used to determine which files are
32
shown, and each file may be printed multiple times if there are
33
-multiple entries in the index or multiple statuses are applicable for
33
+multiple entries in the index or if multiple statuses are applicable for
34
the relevant file selection options.
35
36
OPTIONS
Documentation/git-maintenance.txt
+3
-3
@@ -102,9 +102,9 @@ prefetch::
102
requested refs within `refs/prefetch/`. Also, tags are not updated.
103
+
104
This is done to avoid disrupting the remote-tracking branches. The end users
105
-expect these refs to stay unmoved unless they initiate a fetch. With prefetch
106
-task, however, the objects necessary to complete a later real fetch would
107
-already be obtained, so the real fetch would go faster. In the ideal case,
105
+expect these refs to stay unmoved unless they initiate a fetch. However,
106
+with the prefetch task, the objects necessary to complete a later real fetch
107
+would already be obtained, making the real fetch faster. In the ideal case,
108
it will just become an update to a bunch of remote-tracking branches without
109
any object transfer.
110
Documentation/git-merge.txt
+1
-1
@@ -336,7 +336,7 @@ After seeing a conflict, you can do two things:
336
You can work through the conflict with a number of tools:
337
338
* Use a mergetool. `git mergetool` to launch a graphical
339
- mergetool which will work you through the merge.
339
+ mergetool which will work through the merge with you.
340
341
* Look at the diffs. `git diff` will show a three-way diff,
342
highlighting changes from both the `HEAD` and `MERGE_HEAD`
Documentation/git-mergetool.txt
+1
-1
@@ -115,7 +115,7 @@ These are safe to remove once a file has been merged and its
115
`git mergetool` session has completed.
116
117
Setting the `mergetool.keepBackup` configuration variable to `false`
118
-causes `git mergetool` to automatically remove the backup as files
118
+causes `git mergetool` to automatically remove the backup files as files
119
are successfully merged.
120
121
BACKEND SPECIFIC HINTS
Documentation/git-mktree.txt
+2
-2
@@ -25,13 +25,13 @@ OPTIONS
25
26
--missing::
27
Allow missing objects. The default behaviour (without this option)
28
- is to verify that each tree entry's sha1 identifies an existing
28
+ is to verify that each tree entry's hash identifies an existing
29
object. This option has no effect on the treatment of gitlink entries
30
(aka "submodules") which are always allowed to be missing.
31
32
--batch::
33
Allow building of more than one tree object before exiting. Each
34
- tree is separated by a single blank line. The final new-line is
34
+ tree is separated by a single blank line. The final newline is
35
optional. Note - if the `-z` option is used, lines are terminated
36
with NUL.
37
Documentation/git-range-diff.txt
+1
-1
@@ -70,7 +70,7 @@ to revert to color all lines according to the outer diff markers
70
Defaults to 60. Try a larger value if `git range-diff` erroneously
71
considers a large change a total rewrite (deletion of one commit
72
and addition of another), and a smaller one in the reverse case.
73
- See the ``Algorithm`` section below for an explanation why this is
73
+ See the ``Algorithm`` section below for an explanation of why this is
74
needed.
75
76
--left-only::
Documentation/git-read-tree.txt
+1
-1
@@ -25,7 +25,7 @@ fast-forward (i.e. 2-way) merge, or a 3-way merge, with the `-m`
25
flag. When used with `-m`, the `-u` flag causes it to also update
26
the files in the work tree with the result of the merge.
27
28
-Trivial merges are done by 'git read-tree' itself. Only conflicting paths
28
+Only trivial merges are done by 'git read-tree' itself. Only conflicting paths
29
will be in unmerged state when 'git read-tree' returns.
30
31
OPTIONS
Documentation/git-remote-ext.txt
+1
-1
@@ -82,7 +82,7 @@ begins with `ext::`. Examples:
82
83
"ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'"::
84
Like host.example:foo/repo, but use /home/foo/.ssh/somekey as
85
- keypair and user as user on remote side. This avoids needing to
85
+ keypair and user as user on remote side. This avoids the need to
86
edit .ssh/config.
87
88
"ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo"::
Documentation/git-repack.txt
+1
-1
@@ -165,7 +165,7 @@ depth is 4095.
165
Exclude the given pack from repacking. This is the equivalent
166
of having `.keep` file on the pack. `<pack-name>` is the
167
pack file name without leading directory (e.g. `pack-123.pack`).
168
- The option could be specified multiple times to keep multiple
168
+ The option can be specified multiple times to keep multiple
169
packs.
170
171
--unpack-unreachable=<when>::
Documentation/git-restore.txt
+1
-1
@@ -105,7 +105,7 @@ in linkgit:git-checkout[1] for details.
105
specified. Unmerged paths on the working tree are left alone.
106
107
--ignore-skip-worktree-bits::
108
- In sparse checkout mode, by default is to only update entries
108
+ In sparse checkout mode, the default is to only update entries
109
matched by `<pathspec>` and sparse patterns in
110
$GIT_DIR/info/sparse-checkout. This option ignores the sparse
111
patterns and unconditionally restores any files in
Documentation/git-rev-list.txt
+1
-1
@@ -17,7 +17,7 @@ DESCRIPTION
17
:git-rev-list: 1
18
include::rev-list-description.txt[]
19
20
-'rev-list' is a very essential Git command, since it
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
23
used by commands as different as 'git bisect' and
Documentation/git-rev-parse.txt
+1
-1
@@ -36,7 +36,7 @@ Each of these options must appear first on the command line.
36
--sq-quote::
37
Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
38
section below). In contrast to the `--sq` option below, this
39
- mode does only quoting. Nothing else is done to command input.
39
+ mode only does quoting. Nothing else is done to command input.
40
41
Options for --parseopt
42
~~~~~~~~~~~~~~~~~~~~~~
Documentation/git-send-email.txt
+2
-2
@@ -468,8 +468,8 @@ Information
468
469
--dump-aliases::
470
Instead of the normal operation, dump the shorthand alias names from
471
- the configured alias file(s), one per line in alphabetical order. Note,
472
- this only includes the alias name and not its expanded email addresses.
471
+ the configured alias file(s), one per line in alphabetical order. Note
472
+ that this only includes the alias name and not its expanded email addresses.
473
See 'sendemail.aliasesfile' for more information about aliases.
474
475
Documentation/git-send-pack.txt
+5
-5
@@ -55,7 +55,7 @@ be in a separate packet, and the list must end with a flush packet.
55
--force::
56
Usually, the command refuses to update a remote ref that
57
is not an ancestor of the local ref used to overwrite it.
58
- This flag disables the check. What this means is that
58
+ This flag disables the check. This means that
59
the remote repository can lose commits; use it with
60
care.
61
@@ -117,7 +117,7 @@ When one or more '<ref>' are specified explicitly (whether on the
117
command line or via `--stdin`), it can be either a
118
single pattern, or a pair of such pattern separated by a colon
119
":" (this means that a ref name cannot have a colon in it). A
120
-single pattern '<name>' is just a shorthand for '<name>:<name>'.
120
+single pattern '<name>' is just shorthand for '<name>:<name>'.
121
122
Each pattern pair consists of the source side (before the colon)
123
and the destination side (after the colon). The ref to be
@@ -143,9 +143,9 @@ name. See linkgit:git-rev-parse[1].
143
144
Without `--force`, the <src> ref is stored at the remote only if
145
<dst> does not exist, or <dst> is a proper subset (i.e. an
146
-ancestor) of <src>. This check, known as "fast-forward check",
147
-is performed in order to avoid accidentally overwriting the
148
-remote ref and lose other peoples' commits from there.
146
+ancestor) of <src>. This check, known as the "fast-forward check",
147
+is performed to avoid accidentally overwriting the
148
+remote ref and losing other people's commits from there.
149
150
With `--force`, the fast-forward check is disabled for all refs.
151
Documentation/git-status.txt
+1
-1
@@ -251,7 +251,7 @@ Submodules have more state and instead report
251
m the submodule has modified content
252
? the submodule has untracked files
253
254
-since modified content or untracked files in a submodule cannot be added
254
+This is since modified content or untracked files in a submodule cannot be added
255
via `git add` in the superproject to prepare a commit.
256
257
'm' and '?' are applied recursively. For example if a nested submodule
Documentation/git-stripspace.txt
+1
-1
@@ -41,7 +41,7 @@ OPTIONS
41
42
-c::
43
--comment-lines::
44
- Prepend comment character and blank to each line. Lines will automatically
44
+ Prepend the comment character and a blank space to each line. Lines will automatically
45
be terminated with a newline. On empty lines, only the comment character
46
will be prepended.
47
Documentation/git-var.txt
+1
-1
@@ -19,7 +19,7 @@ no value.
19
OPTIONS
20
-------
21
-l::
22
- Cause the logical variables to be listed. In addition, all the
22
+ Display the logical variables. In addition, all the
23
variables of the Git configuration file .git/config are listed
24
as well. (However, the configuration variables listing functionality
25
is deprecated in favor of `git config -l`.)
Documentation/git-whatchanged.txt
+1
-1
@@ -20,7 +20,7 @@ New users are encouraged to use linkgit:git-log[1] instead. The
20
`whatchanged` command is essentially the same as linkgit:git-log[1]
21
but defaults to show the raw format diff output and to skip merges.
22
23
-The command is kept primarily for historical reasons; fingers of
23
+The command is primarily kept for historical reasons; fingers of
24
many people who learned Git long before `git log` was invented by
25
reading Linux kernel mailing list are trained to type it.
26
Documentation/gitformat-bundle.txt
+3
-3
@@ -86,10 +86,10 @@ In the bundle format, there can be a comment following a prerequisite obj-id.
86
This is a comment and it has no specific meaning. The writer of the bundle MAY
87
put any string here. The reader of the bundle MUST ignore the comment.
88
89
-Note on the shallow clone and a Git bundle
90
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89
+Note on shallow clones and Git bundles
90
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91
92
-Note that the prerequisites does not represent a shallow-clone boundary. The
92
+Note that the prerequisites do not represent a shallow-clone boundary. The
93
semantics of the prerequisites and the shallow-clone boundaries are different,
94
and the Git bundle v2 format cannot represent a shallow clone repository.
95
Documentation/githooks.txt
+1
-1
@@ -345,7 +345,7 @@ for the user.
345
346
The default 'update' hook, when enabled--and with
347
`hooks.allowunannotated` config option unset or set to false--prevents
348
-unannotated tags to be pushed.
348
+unannotated tags from being pushed.
349
350
[[proc-receive]]
351
proc-receive
Documentation/gitprotocol-capabilities.txt
+7
-7
@@ -61,8 +61,8 @@ complete cut across the DAG, or the client has said "done".
61
Without multi_ack, a client sends have lines in --date-order until
62
the server has found a common base. That means the client will send
63
have lines that are already known by the server to be common, because
64
-they overlap in time with another branch that the server hasn't found
65
-a common base on yet.
64
+they overlap in time with another branch on which the server hasn't found
65
+a common base yet.
66
67
For example suppose the client has commits in caps that the server
68
doesn't and the server has commits in lower case that the client
@@ -135,7 +135,7 @@ to disable the feature in a backwards-compatible manner.
135
side-band, side-band-64k
136
------------------------
137
138
-This capability means that server can send, and client understand multiplexed
138
+This capability means that the server can send, and the client can understand, multiplexed
139
progress reports and error info interleaved with the packfile itself.
140
141
These two options are mutually exclusive. A modern client always
@@ -163,14 +163,14 @@ Further, with side-band and its up to 1000-byte messages, it's actually
163
same deal, you have up to 65519 bytes of data and 1 byte for the stream
164
code.
165
166
-The client MUST send only maximum of one of "side-band" and "side-
167
-band-64k". Server MUST diagnose it as an error if client requests
166
+The client MUST send only one of "side-band" and "side-
167
+band-64k". The server MUST diagnose it as an error if client requests
168
both.
169
170
ofs-delta
171
---------
172
173
-Server can send, and client understand PACKv2 with delta referring to
173
+The server can send, and the client can understand, PACKv2 with delta referring to
174
its base by position in pack rather than by an obj-id. That is, they can
175
send/read OBJ_OFS_DELTA (aka type 6) in a packfile.
176
@@ -252,7 +252,7 @@ the current shallow boundary, instead of the depth from remote refs.
252
no-progress
253
-----------
254
255
-The client was started with "git clone -q" or something, and doesn't
255
+The client was started with "git clone -q" or something similar, and doesn't
256
want that side band 2. Basically the client just says "I do not
257
wish to receive stream 2 on sideband, so do not send it to me, and if
258
you did, I will drop it on the floor anyway". However, the sideband
Documentation/gitprotocol-http.txt
+2
-2
@@ -379,7 +379,7 @@ C: Place any object seen into set `advertised`.
379
C: Build an empty set, `common`, to hold the objects that are later
380
determined to be on both ends.
381
382
-C: Build a set, `want`, of the objects from `advertised` the client
382
+C: Build a set, `want`, of the objects from `advertised` that the client
383
wants to fetch, based on what it saw during ref discovery.
384
385
C: Start a queue, `c_pending`, ordered by commit time (popping newest
@@ -423,7 +423,7 @@ multiple commands. Object names MUST be given using the object format
423
negotiated through the `object-format` capability (default SHA-1).
424
425
The `have` list is created by popping the first 32 commits
426
-from `c_pending`. Less can be supplied if `c_pending` empties.
426
+from `c_pending`. Fewer can be supplied if `c_pending` empties.
427
428
If the client has sent 256 "have" commits and has not yet
429
received one of those back from `s_common`, or the client has
Documentation/gitweb.txt
+2
-2
@@ -20,13 +20,13 @@ Gitweb provides a web interface to Git repositories. Its features include:
20
* Browsing every revision of the repository.
21
* Viewing the contents of files in the repository at any revision.
22
* Viewing the revision log of branches, history of files and directories,
23
- see what was changed when, by who.
23
+ seeing what was changed, when, and by whom.
24
* Viewing the blame/annotation details of any file (if enabled).
25
* Generating RSS and Atom feeds of commits, for any branch.
26
The feeds are auto-discoverable in modern web browsers.
27
* Viewing everything that was changed in a revision, and step through
28
revisions one at a time, viewing the history of the repository.
29
-* Finding commits which commit messages matches given search term.
29
+* Finding commits whose commit messages match a given search term.
30
31
See http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/[] for gitweb source code,
32
browsed using gitweb itself.
Documentation/howto/maintain-git.txt
+2
-2
@@ -104,7 +104,7 @@ by doing the following:
104
files in mbox format).
105
106
- Write his own patches to address issues raised on the list but
107
- nobody has stepped up solving. Send it out just like other
107
+ nobody has stepped up to solve. Send it out just like other
108
contributors do, and pick them up just like patches from other
109
contributors (see above).
110
@@ -417,7 +417,7 @@ are merged together, the reference to the variable newly added by
417
the latter topic will still use the old name in the result.
418
419
The Meta/Reintegrate script that is used by redo-jch and redo-seen
420
-scripts implements a crude but usable way to work this issue around.
420
+scripts implements a crude but usable way to work around this issue.
421
When the script merges branch $X, it checks if "refs/merge-fix/$X"
422
exists, and if so, the effect of it is squashed into the result of
423
the mechanical merge. In other words,
Documentation/howto/using-merge-subtree.txt
+1
-1
@@ -11,7 +11,7 @@ Message-ID: <BAYC1-PASMTP12374B54BA370A1E1C6E78AE4E0@CEZ.ICE>
11
How to use the subtree merge strategy
12
=====================================
13
14
-There are situations where you want to include contents in your project
14
+There are situations where you want to include content in your project
15
from an independently developed project. You can just pull from the
16
other project as long as there are no conflicting paths.
17
Documentation/i18n.txt
+1
-1
@@ -46,7 +46,7 @@ mind.
46
------------
47
+
48
Commit objects created with the above setting record the value
49
-of `i18n.commitEncoding` in its `encoding` header. This is to
49
+of `i18n.commitEncoding` in their `encoding` header. This is to
50
help other people who look at them later. Lack of this header
51
implies that the commit log message is encoded in UTF-8.
52
Documentation/mergetools/vimdiff.txt
+2
-2
@@ -32,10 +32,10 @@ have special meaning:
32
- `+` is used to "open a new tab"
33
- `,` is used to "open a new vertical split"
34
- `/` is used to "open a new horizontal split"
35
- - `@` is used to indicate which is the file containing the final version after
35
+ - `@` is used to indicate the file containing the final version after
36
solving the conflicts. If not present, `MERGED` will be used by default.
37
38
-The precedence of the operators is this one (you can use parentheses to change
38
+The precedence of the operators is as follows (you can use parentheses to change
39
it):
40
41
`@` > `+` > `/` > `,`
Documentation/technical/api-simple-ipc.txt
+1
-1
@@ -102,4 +102,4 @@ stateless request, receive an application-specific
102
response, and disconnect. It is a one round trip facility for
103
querying the server. The Simple-IPC routines hide the socket,
104
named pipe, and thread pool details and allow the application
105
-layer to focus on the application at hand.
105
+layer to focus on the task at hand.
Documentation/technical/bitmap-format.txt
+1
-1
@@ -114,7 +114,7 @@ result in an empty bitmap (no bits set).
114
115
* N entries with compressed bitmaps, one for each indexed commit
116
+
117
-Where `N` is the total amount of entries in this bitmap index.
117
+Where `N` is the total number of entries in this bitmap index.
118
Each entry contains the following:
119
120
** {empty}
Documentation/technical/parallel-checkout.txt
+1
-1
@@ -185,7 +185,7 @@ quite straightforward: for each parallel-eligible entry, the main
185
process must remove all files that prevent this entry from being written
186
(before enqueueing it). This includes any non-directory file in the
187
leading path of the entry. Later, when a worker gets assigned the entry,
188
-it looks again for the non-directories files and for an already existing
188
+it looks again for the non-directory files and for an already existing
189
file at the entry's path. If any of these checks finds something, the
190
worker knows that there was a path collision.
191
Documentation/technical/partial-clone.txt
+1
-1
@@ -265,7 +265,7 @@ Future Work
265
- Improve the way to specify the order in which promisor remotes are
266
tried.
267
+
268
-For example this could allow to specify explicitly something like:
268
+For example this could allow specifying explicitly something like:
269
"When fetching from this remote, I want to use these promisor remotes
270
in this order, though, when pushing or fetching to that remote, I want
271
to use those promisor remotes in that order."
Documentation/technical/racy-git.txt
+3
-3
@@ -165,9 +165,9 @@ Avoiding runtime penalty
165
166
In order to avoid the above runtime penalty, post 1.4.2 Git used
167
to have a code that made sure the index file
168
-got timestamp newer than the youngest files in the index when
169
-there are many young files with the same timestamp as the
170
-resulting index file would otherwise would have by waiting
168
+got a timestamp newer than the youngest files in the index when
169
+there were many young files with the same timestamp as the
170
+resulting index file otherwise would have by waiting
171
before finishing writing the index file out.
172
173
I suspected that in practice the situation where many paths in the
Documentation/technical/reftable.txt
+1
-1
@@ -115,7 +115,7 @@ Varint encoding
115
Varint encoding is identical to the ofs-delta encoding method used
116
within pack files.
117
118
-Decoder works such as:
118
+Decoder works as follows:
119
120
....
121
val = buf[ptr] & 0x7f
Documentation/urls.txt
+2
-2
@@ -6,9 +6,9 @@ address of the remote server, and the path to the repository.
6
Depending on the transport protocol, some of this information may be
7
absent.
8
9
-Git supports ssh, git, http, and https protocols (in addition, ftp,
9
+Git supports ssh, git, http, and https protocols (in addition, ftp
10
and ftps can be used for fetching, but this is inefficient and
11
-deprecated; do not use it).
11
+deprecated; do not use them).
12
13
The native transport (i.e. git:// URL) does no authentication and
14
should be used with caution on unsecured networks.