diff options
author | Elijah Newren <newren@gmail.com> | 2023-10-08 06:45:03 +0000 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2023-10-09 12:04:21 -0700 |
commit | cf6cac20059123d6ec3f867bb3692df62db52cf9 (patch) | |
tree | 99e0ee363183782b239257d69d28282c44100136 /Documentation/config | |
parent | 3a06386e314565108ad56a9bdb8f7b80ac52fb69 (diff) | |
download | git-cf6cac20059123d6ec3f867bb3692df62db52cf9.tar.gz |
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>
Diffstat (limited to 'Documentation/config')
-rw-r--r-- | Documentation/config/apply.txt | 2 | ||||
-rw-r--r-- | Documentation/config/branch.txt | 2 | ||||
-rw-r--r-- | Documentation/config/clone.txt | 4 | ||||
-rw-r--r-- | Documentation/config/credential.txt | 2 | ||||
-rw-r--r-- | Documentation/config/fetch.txt | 4 | ||||
-rw-r--r-- | Documentation/config/fsck.txt | 4 | ||||
-rw-r--r-- | Documentation/config/fsmonitor--daemon.txt | 2 | ||||
-rw-r--r-- | Documentation/config/gc.txt | 2 | ||||
-rw-r--r-- | Documentation/config/gpg.txt | 2 | ||||
-rw-r--r-- | Documentation/config/http.txt | 2 | ||||
-rw-r--r-- | Documentation/config/imap.txt | 2 | ||||
-rw-r--r-- | Documentation/config/mergetool.txt | 2 | ||||
-rw-r--r-- | Documentation/config/pack.txt | 6 | ||||
-rw-r--r-- | Documentation/config/receive.txt | 2 | ||||
-rw-r--r-- | Documentation/config/safe.txt | 4 | ||||
-rw-r--r-- | Documentation/config/submodule.txt | 2 | ||||
-rw-r--r-- | Documentation/config/trace2.txt | 2 | ||||
-rw-r--r-- | Documentation/config/transfer.txt | 4 | ||||
-rw-r--r-- | Documentation/config/user.txt | 2 |
19 files changed, 26 insertions, 26 deletions
diff --git a/Documentation/config/apply.txt b/Documentation/config/apply.txt index 8fb8ef763d..3f9ff19db6 100644 --- a/Documentation/config/apply.txt +++ b/Documentation/config/apply.txt @@ -2,7 +2,7 @@ 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]. diff --git a/Documentation/config/branch.txt b/Documentation/config/branch.txt index 445341a906..2b05ed3574 100644 --- a/Documentation/config/branch.txt +++ b/Documentation/config/branch.txt @@ -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 diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt index 26f4fb137a..a16b1b6fa3 100644 --- a/Documentation/config/clone.txt +++ b/Documentation/config/clone.txt @@ -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 to clone 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 diff --git a/Documentation/config/credential.txt b/Documentation/config/credential.txt index 512f31876e..075ef8c975 100644 --- a/Documentation/config/credential.txt +++ b/Documentation/config/credential.txt @@ -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). diff --git a/Documentation/config/fetch.txt b/Documentation/config/fetch.txt index 568f0f75b3..c1a7cdd6bf 100644 --- a/Documentation/config/fetch.txt +++ b/Documentation/config/fetch.txt @@ -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 detail. fetch.negotiationAlgorithm:: Control how information about the commits in the local repository diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt index a3c865df56..fec3eefb5b 100644 --- a/Documentation/config/fsck.txt +++ b/Documentation/config/fsck.txt @@ -17,7 +17,7 @@ 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. +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 @@ -59,7 +59,7 @@ 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. +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 diff --git a/Documentation/config/fsmonitor--daemon.txt b/Documentation/config/fsmonitor--daemon.txt index c225c6c9e7..671f9b9462 100644 --- a/Documentation/config/fsmonitor--daemon.txt +++ b/Documentation/config/fsmonitor--daemon.txt @@ -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`. diff --git a/Documentation/config/gc.txt b/Documentation/config/gc.txt index ca47eb2008..17e2a8cc17 100644 --- a/Documentation/config/gc.txt +++ b/Documentation/config/gc.txt @@ -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`. diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt index 37e2831cd5..a31faab2ed 100644 --- a/Documentation/config/gpg.txt +++ b/Documentation/config/gpg.txt @@ -4,7 +4,7 @@ gpg.program:: same command-line interface as GPG, namely, to verify a detached signature, "`gpg --verify $signature - <$file`" is run, and the program is expected to signal a good signature by exiting with - code 0, and to generate an ASCII-armored detached signature, the + code 0. To generate an ASCII-armored detached signature, the standard input of "`gpg -bsau $key`" is fed with the contents to be signed, and the program is expected to send the result to its standard output. diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt index 51a70781e5..1d805fdddb 100644 --- a/Documentation/config/http.txt +++ b/Documentation/config/http.txt @@ -260,7 +260,7 @@ http.noEPSV:: http.userAgent:: The HTTP USER_AGENT string presented to an HTTP server. The default - value represents the version of the client Git such as git/1.7.1. + value represents the version of the Git client such as git/1.7.1. This option allows you to override this value to a more common value such as Mozilla/4.0. This may be necessary, for instance, if connecting through a firewall that restricts HTTP connections to a set diff --git a/Documentation/config/imap.txt b/Documentation/config/imap.txt index 06166fb5c0..fa0dccc3d8 100644 --- a/Documentation/config/imap.txt +++ b/Documentation/config/imap.txt @@ -37,7 +37,7 @@ imap.preformattedHTML:: format=fixed email. Default is `false`. imap.authMethod:: - Specify authenticate method for authentication with IMAP server. + Specify the authentication method for authenticating with the IMAP server. If Git was built with the NO_CURL option, or if your curl version is older than 7.34.0, or if you're running git-imap-send with the `--no-curl` option, the only supported method is 'CRAM-MD5'. If this is not set diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.txt index 56a7eeeffb..e9abde9d60 100644 --- a/Documentation/config/mergetool.txt +++ b/Documentation/config/mergetool.txt @@ -47,7 +47,7 @@ mergetool.meld.useAutoMerge:: mergetool.vimdiff.layout:: The vimdiff backend uses this variable to control how its split - windows look like. Applies even if you are using Neovim (`nvim`) or + windows appear. Applies even if you are using Neovim (`nvim`) or gVim (`gvim`) as the merge tool. See BACKEND SPECIFIC HINTS section ifndef::git-mergetool[] in linkgit:git-mergetool[1]. diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.txt index 3748136d14..dcd4c871b3 100644 --- a/Documentation/config/pack.txt +++ b/Documentation/config/pack.txt @@ -83,7 +83,7 @@ pack.indexVersion:: the new pack index with capabilities for packs larger than 4 GB as well as proper protection against the repacking of corrupted packs. Version 2 is the default. Note that version 2 is enforced - and this config option ignored whenever the corresponding pack is + and this config option is ignored whenever the corresponding pack is larger than 2 GB. + If you have an old Git that does not understand the version 2 `*.idx` file, @@ -102,8 +102,8 @@ pack.packSizeLimit:: in the creation of multiple packfiles. + Note that this option is rarely useful, and may result in a larger total -on-disk size (because Git will not store deltas between packs), as well -as worse runtime performance (object lookup within multiple packs is +on-disk size (because Git will not store deltas between packs) and +worse runtime performance (object lookup within multiple packs is slower than a single pack, and optimizations like reachability bitmaps cannot cope with multiple packs). + diff --git a/Documentation/config/receive.txt b/Documentation/config/receive.txt index 85d5b5a3d2..ae526cbf58 100644 --- a/Documentation/config/receive.txt +++ b/Documentation/config/receive.txt @@ -19,7 +19,7 @@ receive.certNonceSeed:: key. receive.certNonceSlop:: - When a `git push --signed` sent a push certificate with a + When a `git push --signed` sends a push certificate with a "nonce" that was issued by a receive-pack serving the same repository within this many seconds, export the "nonce" found in the certificate to `GIT_PUSH_CERT_NONCE` to the diff --git a/Documentation/config/safe.txt b/Documentation/config/safe.txt index bde7f31459..577df40223 100644 --- a/Documentation/config/safe.txt +++ b/Documentation/config/safe.txt @@ -14,7 +14,7 @@ repository that contains a bare repository and running a Git command within that directory. + This config setting is only respected in protected configuration (see -<<SCOPES>>). This prevents the untrusted repository from tampering with +<<SCOPES>>). This prevents untrusted repositories from tampering with this value. safe.directory:: @@ -32,7 +32,7 @@ override any such directories specified in the system config), add a `safe.directory` entry with an empty value. + This config setting is only respected in protected configuration (see -<<SCOPES>>). This prevents the untrusted repository from tampering with this +<<SCOPES>>). This prevents untrusted repositories from tampering with this value. + The value of this setting is interpolated, i.e. `~/<path>` expands to a diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt index 6490527b45..665419fa13 100644 --- a/Documentation/config/submodule.txt +++ b/Documentation/config/submodule.txt @@ -2,7 +2,7 @@ submodule.<name>.url:: The URL for a submodule. This variable is copied from the .gitmodules file to the git config via 'git submodule init'. The user can change the configured URL before obtaining the submodule via 'git submodule - update'. If neither submodule.<name>.active or submodule.active are + update'. If neither submodule.<name>.active nor submodule.active are set, the presence of this variable is used as a fallback to indicate whether the submodule is of interest to git commands. See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. diff --git a/Documentation/config/trace2.txt b/Documentation/config/trace2.txt index fe1642f0d4..3b6bca2b7a 100644 --- a/Documentation/config/trace2.txt +++ b/Documentation/config/trace2.txt @@ -66,6 +66,6 @@ trace2.destinationDebug:: trace2.maxFiles:: Integer. When writing trace files to a target directory, do not - write additional traces if we would exceed this many files. Instead, + write additional traces if doing so would exceed this many files. Instead, write a sentinel file that will block further tracing to this directory. Defaults to 0, which disables this check. diff --git a/Documentation/config/transfer.txt b/Documentation/config/transfer.txt index c3ac767d1e..55e13428db 100644 --- a/Documentation/config/transfer.txt +++ b/Documentation/config/transfer.txt @@ -7,7 +7,7 @@ transfer.credentialsInUrl:: and any other direct use of the configured URL. + Note that this is currently limited to detecting credentials in -`remote.<name>.url` configuration, it won't detect credentials in +`remote.<name>.url` configuration; it won't detect credentials in `remote.<name>.pushurl` configuration. + You might want to enable this to prevent inadvertent credentials @@ -26,7 +26,7 @@ exposure, e.g. because: documented in procfs(5) allows for configuring this behavior. + If such concerns don't apply to you then you probably don't need to be -concerned about credentials exposure due to storing that sensitive +concerned about credentials exposure due to storing sensitive data in git's configuration files. If you do want to use this, set `transfer.credentialsInUrl` to one of these values: + diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt index ec9233b060..958e62464a 100644 --- a/Documentation/config/user.txt +++ b/Documentation/config/user.txt @@ -10,7 +10,7 @@ committer.email:: If you need the `author` or `committer` to be different, the `author.name`, `author.email`, `committer.name` or `committer.email` variables can be set. - Also, all of these can be overridden by the `GIT_AUTHOR_NAME`, + All of these can be overridden by the `GIT_AUTHOR_NAME`, `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`, `GIT_COMMITTER_EMAIL` and `EMAIL` environment variables. + |