From cf6cac20059123d6ec3f867bb3692df62db52cf9 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:03 +0000 Subject: [PATCH 01/25] documentation: wording improvements Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 4 ++-- Documentation/ToolsForGit.txt | 2 +- Documentation/config.txt | 4 ++-- Documentation/config/apply.txt | 2 +- Documentation/config/branch.txt | 2 +- Documentation/config/clone.txt | 4 ++-- Documentation/config/credential.txt | 2 +- Documentation/config/fetch.txt | 4 ++-- Documentation/config/fsck.txt | 4 ++-- Documentation/config/fsmonitor--daemon.txt | 2 +- Documentation/config/gc.txt | 2 +- Documentation/config/gpg.txt | 2 +- Documentation/config/http.txt | 2 +- Documentation/config/imap.txt | 2 +- Documentation/config/mergetool.txt | 2 +- Documentation/config/pack.txt | 6 +++--- Documentation/config/receive.txt | 2 +- Documentation/config/safe.txt | 4 ++-- Documentation/config/submodule.txt | 2 +- Documentation/config/trace2.txt | 2 +- Documentation/config/transfer.txt | 4 ++-- Documentation/config/user.txt | 2 +- Documentation/diff-generate-patch.txt | 4 ++-- Documentation/diff-options.txt | 2 +- Documentation/git-apply.txt | 2 +- Documentation/git-archive.txt | 16 ++++++++-------- Documentation/git-bugreport.txt | 9 +++++---- Documentation/git-checkout-index.txt | 2 +- Documentation/git-count-objects.txt | 4 ++-- Documentation/git-credential.txt | 2 +- Documentation/git-diff-index.txt | 4 ++-- Documentation/git-diff-tree.txt | 2 +- Documentation/git-fast-import.txt | 2 +- Documentation/git-hash-object.txt | 8 ++++---- Documentation/git-help.txt | 2 +- Documentation/git-http-backend.txt | 10 +++++----- Documentation/git-http-fetch.txt | 2 +- Documentation/git-http-push.txt | 4 ++-- Documentation/git-index-pack.txt | 10 +++++----- Documentation/git-init.txt | 2 +- Documentation/git-ls-files.txt | 6 +++--- Documentation/git-maintenance.txt | 6 +++--- Documentation/git-merge.txt | 2 +- Documentation/git-mergetool.txt | 2 +- Documentation/git-mktree.txt | 4 ++-- Documentation/git-range-diff.txt | 2 +- Documentation/git-read-tree.txt | 2 +- Documentation/git-remote-ext.txt | 2 +- Documentation/git-repack.txt | 2 +- Documentation/git-restore.txt | 2 +- Documentation/git-rev-list.txt | 2 +- Documentation/git-rev-parse.txt | 2 +- Documentation/git-send-email.txt | 4 ++-- Documentation/git-send-pack.txt | 10 +++++----- Documentation/git-status.txt | 2 +- Documentation/git-stripspace.txt | 2 +- Documentation/git-var.txt | 2 +- Documentation/git-whatchanged.txt | 2 +- Documentation/gitformat-bundle.txt | 6 +++--- Documentation/githooks.txt | 2 +- Documentation/gitprotocol-capabilities.txt | 14 +++++++------- Documentation/gitprotocol-http.txt | 4 ++-- Documentation/gitweb.txt | 4 ++-- Documentation/howto/maintain-git.txt | 4 ++-- Documentation/howto/using-merge-subtree.txt | 2 +- Documentation/i18n.txt | 2 +- Documentation/mergetools/vimdiff.txt | 4 ++-- Documentation/technical/api-simple-ipc.txt | 2 +- Documentation/technical/bitmap-format.txt | 2 +- Documentation/technical/parallel-checkout.txt | 2 +- Documentation/technical/partial-clone.txt | 2 +- Documentation/technical/racy-git.txt | 6 +++--- Documentation/technical/reftable.txt | 2 +- Documentation/urls.txt | 4 ++-- 74 files changed, 134 insertions(+), 133 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 65af8d82cedd5f..99b22ff2345060 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -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." diff --git a/Documentation/ToolsForGit.txt b/Documentation/ToolsForGit.txt index 5060d0d2314c31..5d01e8191aa73e 100644 --- a/Documentation/ToolsForGit.txt +++ b/Documentation/ToolsForGit.txt @@ -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 diff --git a/Documentation/config.txt b/Documentation/config.txt index 229b63a454c035..9273c7f1c6564f 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -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 @@ -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 a `includeIf..path` variable to the name of the file to be included. diff --git a/Documentation/config/apply.txt b/Documentation/config/apply.txt index 8fb8ef763dfdf2..3f9ff19db6b865 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 445341a906b241..2b05ed3574bf4a 100644 --- a/Documentation/config/branch.txt +++ b/Documentation/config/branch.txt @@ -36,7 +36,7 @@ branch.sort:: branch..remote:: When on branch , 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..pushRemote`. If no remote is diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt index 26f4fb137a738e..a16b1b6fa343ab 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 512f31876e17ed..075ef8c97503c0 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 568f0f75b3027d..c1a7cdd6bf4242 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 a3c865df5679e3..fec3eefb5b8f37 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.` and `fetch.fsck.` variables will not fall back on the `fsck.` 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.` is set, errors can be switched to warnings and vice versa by configuring the `fsck.` 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 c225c6c9e74cbd..671f9b94628446 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 ca47eb200882a2..17e2a8cc1767d7 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 37e2831cd511c8..a31faab2edd94f 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 51a70781e58cf9..1d805fdddbce61 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 06166fb5c04fe9..fa0dccc3d83491 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 56a7eeeffb4336..e9abde9d60c3d7 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 3748136d141e41..dcd4c871b3a1b9 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 85d5b5a3d2d8bf..ae526cbf5841c3 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 bde7f31459b981..577df40223a095 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 -<>). This prevents the untrusted repository from tampering with +<>). 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 -<>). This prevents the untrusted repository from tampering with this +<>). This prevents untrusted repositories from tampering with this value. + The value of this setting is interpolated, i.e. `~/` expands to a diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt index 6490527b45bcd4..665419fa13586b 100644 --- a/Documentation/config/submodule.txt +++ b/Documentation/config/submodule.txt @@ -2,7 +2,7 @@ submodule..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..active or submodule.active are + update'. If neither submodule..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 fe1642f0d40251..3b6bca2b7ae44c 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 c3ac767d1e4de1..55e13428db1f95 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..url` configuration, it won't detect credentials in +`remote..url` configuration; it won't detect credentials in `remote..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 ec9233b060a82c..958e62464a547f 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. + diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 546adf79e5a52c..55df903abd1aa7 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -146,7 +146,7 @@ information about detected contents movement (renames and copying detection) are designed to work with diff of two and are not used by combined diff format. -3. It is followed by two-line from-file/to-file header +3. It is followed by a two-line from-file/to-file header: --- a/file +++ b/file @@ -157,7 +157,7 @@ files. + However, if the --combined-all-paths option is provided, instead of a two-line from-file/to-file you get a N+1 line from-file/to-file header, -where N is the number of parents in the merge commit +where N is the number of parents in the merge commit: --- a/file --- a/file diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 35fae7c87c8a6b..8917ce7a9e1c5a 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -733,7 +733,7 @@ matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`". --rotate-to=:: Discard the files before the named from the output (i.e. 'skip to'), or move them to the end of the output - (i.e. 'rotate to'). These were invented primarily for use + (i.e. 'rotate to'). These options were invented primarily for the use of the `git difftool` command, and may not be very useful otherwise. diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index 5e16e6db7e2e02..b6e7510d068a2d 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -159,7 +159,7 @@ discouraged. --allow-binary-replacement:: --binary:: - Historically we did not allow binary patch applied + Historically we did not allow binary patch application without an explicit permission from the user, and this flag was the way to do so. Currently we always allow binary patch application, so this is a no-op. diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt index 6bab201d37548d..98526f2bebad16 100644 --- a/Documentation/git-archive.txt +++ b/Documentation/git-archive.txt @@ -21,14 +21,14 @@ structure for the named tree, and writes it out to the standard output. If is specified it is prepended to the filenames in the archive. -'git archive' behaves differently when given a tree ID versus when -given a commit ID or tag ID. In the first case the current time is -used as the modification time of each file in the archive. In the latter -case the commit time as recorded in the referenced commit object is -used instead. Additionally the commit ID is stored in a global -extended pax header if the tar format is used; it can be extracted -using 'git get-tar-commit-id'. In ZIP files it is stored as a file -comment. +'git archive' behaves differently when given a tree ID as opposed to a +commit ID or tag ID. When a tree ID is provided, the current time is +used as the modification time of each file in the archive. On the +other hand, when a commit ID or tag ID is provided, the commit time as +recorded in the referenced commit object is used instead. +Additionally the commit ID is stored in a global extended pax header +if the tar format is used; it can be extracted using 'git +get-tar-commit-id'. In ZIP files it is stored as a file comment. OPTIONS ------- diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt index eca726e57911af..392d9eb6aec6b0 100644 --- a/Documentation/git-bugreport.txt +++ b/Documentation/git-bugreport.txt @@ -13,10 +13,11 @@ SYNOPSIS DESCRIPTION ----------- -Captures information about the user's machine, Git client, and repository state, -as well as a form requesting information about the behavior the user observed, -into a single text file which the user can then share, for example to the Git -mailing list, in order to report an observed bug. +Collects information about the user's machine, Git client, and repository +state, in addition to a form requesting information about the behavior the +user observed, and stores it in a single text file which the user can then +share, for example to the Git mailing list, in order to report an observed +bug. The following information is requested from the user: diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index 01dbd5cbf540ea..d1738f4330850b 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -18,7 +18,7 @@ SYNOPSIS DESCRIPTION ----------- -Will copy all files listed from the index to the working directory +Copies all listed files from the index to the working directory (not overwriting existing files). OPTIONS diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt index cb9b4d2e460ada..b28cc3a510a1c8 100644 --- a/Documentation/git-count-objects.txt +++ b/Documentation/git-count-objects.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- -This counts the number of unpacked object files and disk space consumed by +Counts the number of unpacked object files and disk space consumed by them, to help you decide when it is a good time to repack. @@ -20,7 +20,7 @@ OPTIONS ------- -v:: --verbose:: - Report in more detail: + Provide more detailed reports: + count: the number of loose objects + diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt index a220afed4f35ba..918a0aa42b2415 100644 --- a/Documentation/git-credential.txt +++ b/Documentation/git-credential.txt @@ -94,7 +94,7 @@ unlocked) before it returned `password=secr3t`. that `git credential` will ask for a new password in its next invocation. In either case, `git credential` should be fed with the credential description obtained from step (2) (which also - contain the ones provided in step (1)). + contains the fields provided in step (1)). [[IOFMT]] INPUT/OUTPUT FORMAT diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt index c30d8f0da8a28f..4de1d4c8f11e60 100644 --- a/Documentation/git-diff-index.txt +++ b/Documentation/git-diff-index.txt @@ -13,10 +13,10 @@ SYNOPSIS DESCRIPTION ----------- -Compares the content and mode of the blobs found in a tree object +Compare the content and mode of the blobs found in a tree object with the corresponding tracked files in the working tree, or with the corresponding paths in the index. When arguments are present, -compares only paths matching those patterns. Otherwise all tracked +compare only paths matching those patterns. Otherwise all tracked files are compared. OPTIONS diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 274d5eaba93dab..81caad5c95cedc 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -15,7 +15,7 @@ SYNOPSIS DESCRIPTION ----------- -Compares the content and mode of the blobs found via two tree objects. +Compare the content and mode of blobs found via two tree objects. If there is only one given, the commit is compared with its parents (see --stdin below). diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 8b5dd6add006d1..a6a054f86d2df2 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -622,7 +622,7 @@ in octal. Git only supports the following modes: * `100755` or `755`: A normal, but executable, file. * `120000`: A symlink, the content of the file will be the link target. * `160000`: A gitlink, SHA-1 of the object refers to a commit in - another repository. Git links can only be specified by SHA or through + another repository. Git links can only be specified either by SHA or through a commit mark. They are used to implement submodules. * `040000`: A subdirectory. Subdirectories can only be specified by SHA or through a tree mark set with `--import-marks`. diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt index 8577f7a7d4087d..ef4719ae41c700 100644 --- a/Documentation/git-hash-object.txt +++ b/Documentation/git-hash-object.txt @@ -39,10 +39,10 @@ OPTIONS of from the command-line. --path:: - Hash object as it were located at the given path. The location of - file does not directly influence on the hash value, but path is - used to determine what Git filters should be applied to the object - before it can be placed to the object database, and, as result of + Hash object as if it were located at the given path. The location of + the file does not directly influence the hash value, but the path is + used to determine which Git filters should be applied to the object + before it can be placed in the object database. As a result of applying filters, the actual blob put into the object database may differ from the given file. This option is mainly useful for hashing temporary files located outside of the working directory or files diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 2b0b5e390dcb94..7cb4b4bda18912 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -109,7 +109,7 @@ other display programs (see below). format. A web browser will be used for that purpose. + The web browser can be specified using the configuration variable -`help.browser`, or `web.browser` if the former is not set. If none of +`help.browser`, or `web.browser` if the former is not set. If neither of these config variables is set, the 'git web{litdd}browse' helper script (called by 'git help') will pick a suitable default. See linkgit:git-web{litdd}browse[1] for more information about this. diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt index 0c5c0dde19f0b0..f37ddaded82b42 100644 --- a/Documentation/git-http-backend.txt +++ b/Documentation/git-http-backend.txt @@ -23,7 +23,7 @@ discussion of `GIT_PROTOCOL` in the ENVIRONMENT section below. It verifies that the directory has the magic file "git-daemon-export-ok", and it will refuse to export any Git directory that hasn't explicitly been marked for export this way (unless the -`GIT_HTTP_EXPORT_ALL` environmental variable is set). +`GIT_HTTP_EXPORT_ALL` environment variable is set). By default, only the `upload-pack` service is enabled, which serves 'git fetch-pack' and 'git ls-remote' clients, which are invoked from @@ -42,12 +42,12 @@ http.getanyfile:: any file within the repository, including objects that are no longer reachable from a branch but are still present. It is enabled by default, but a repository can disable it - by setting this configuration item to `false`. + by setting this configuration value to `false`. http.uploadpack:: This serves 'git fetch-pack' and 'git ls-remote' clients. It is enabled by default, but a repository can disable it - by setting this configuration item to `false`. + by setting this configuration value to `false`. http.receivepack:: This serves 'git send-pack' clients, allowing push. It is @@ -265,12 +265,12 @@ by the invoking web server, including: * QUERY_STRING * REQUEST_METHOD -The `GIT_HTTP_EXPORT_ALL` environmental variable may be passed to +The `GIT_HTTP_EXPORT_ALL` environment variable may be passed to 'git-http-backend' to bypass the check for the "git-daemon-export-ok" file in each repository before allowing export of that repository. The `GIT_HTTP_MAX_REQUEST_BUFFER` environment variable (or the -`http.maxRequestBuffer` config variable) may be set to change the +`http.maxRequestBuffer` config option) may be set to change the largest ref negotiation request that git will handle during a fetch; any fetch requiring a larger buffer will not succeed. This value should not normally need to be changed, but may be helpful if you are fetching from diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt index 319062c021bb2c..4ec7c68d3b9ecd 100644 --- a/Documentation/git-http-fetch.txt +++ b/Documentation/git-http-fetch.txt @@ -31,7 +31,7 @@ commit-id:: Report what is downloaded. -w :: - Writes the commit-id into the filename under $GIT_DIR/refs/ on + Writes the commit-id into the specified filename under $GIT_DIR/refs/ on the local end after the transfer is complete. --stdin:: diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt index 7c6a6dd7f6a7fc..8b4a5791c8cf03 100644 --- a/Documentation/git-http-push.txt +++ b/Documentation/git-http-push.txt @@ -83,8 +83,8 @@ and where it is pushed is determined by using the destination side. Without `--force`, the ref is stored at the remote only if does not exist, or is a proper subset (i.e. an ancestor) of . This check, known as "fast-forward check", -is performed in order to avoid accidentally overwriting the -remote ref and lose other peoples' commits from there. +is performed to avoid accidentally overwriting the +remote ref and losing other peoples' commits from there. With `--force`, the fast-forward check is disabled for all refs. diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt index 4e71c256ecb08f..6486620c3d8f2a 100644 --- a/Documentation/git-index-pack.txt +++ b/Documentation/git-index-pack.txt @@ -16,10 +16,10 @@ SYNOPSIS DESCRIPTION ----------- -Reads a packed archive (.pack) from the specified file, and -builds a pack index file (.idx) for it. Optionally writes a +Reads a packed archive (.pack) from the specified file, +builds a pack index file (.idx) for it, and optionally writes a reverse-index (.rev) for the specified pack. The packed -archive together with the pack index can then be placed in +archive, together with the pack index, can then be placed in the objects/pack/ directory of a Git repository. @@ -68,8 +68,8 @@ OPTIONS updated to use objects contained in the pack. --keep=:: - Like --keep create a .keep file before moving the index into - its final destination, but rather than creating an empty file + Like --keep, create a .keep file before moving the index into + its final destination. However, instead of creating an empty file place '' followed by an LF into the .keep file. The '' message can later be searched for within all .keep files to locate any which have outlived their usefulness. diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 160dea1372cd9a..30ab86ab96a7cb 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -99,7 +99,7 @@ specified. 'group' (or 'true'):: -Make the repository group-writable, (and g+sx, since the git group may be not +Make the repository group-writable, (and g+sx, since the git group may not be the primary group of all users). This is used to loosen the permissions of an otherwise safe umask(2) value. Note that the umask still applies to the other permission bits (e.g. if umask is '0022', using 'group' will not remove read diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 1bc0328bb78928..60d1cca14960bd 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -25,12 +25,12 @@ SYNOPSIS DESCRIPTION ----------- -This merges the file listing in the index with the actual working +This command merges the file listing in the index with the actual working directory list, and shows different combinations of the two. -One or more of the options below may be used to determine the files +Several flags can be used to determine which files are shown, and each file may be printed multiple times if there are -multiple entries in the index or multiple statuses are applicable for +multiple entries in the index or if multiple statuses are applicable for the relevant file selection options. OPTIONS diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt index 805e5a2e3a044b..51d0f7e94b6a01 100644 --- a/Documentation/git-maintenance.txt +++ b/Documentation/git-maintenance.txt @@ -102,9 +102,9 @@ prefetch:: requested refs within `refs/prefetch/`. Also, tags are not updated. + This is done to avoid disrupting the remote-tracking branches. The end users -expect these refs to stay unmoved unless they initiate a fetch. With prefetch -task, however, the objects necessary to complete a later real fetch would -already be obtained, so the real fetch would go faster. In the ideal case, +expect these refs to stay unmoved unless they initiate a fetch. However, +with the prefetch task, the objects necessary to complete a later real fetch +would already be obtained, making the real fetch faster. In the ideal case, it will just become an update to a bunch of remote-tracking branches without any object transfer. diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index 8625c5cb0ec2d3..e8ab34031919fa 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -336,7 +336,7 @@ After seeing a conflict, you can do two things: You can work through the conflict with a number of tools: * Use a mergetool. `git mergetool` to launch a graphical - mergetool which will work you through the merge. + mergetool which will work through the merge with you. * Look at the diffs. `git diff` will show a three-way diff, highlighting changes from both the `HEAD` and `MERGE_HEAD` diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 07535f6576e81a..800a3cbe6f3bea 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -115,7 +115,7 @@ These are safe to remove once a file has been merged and its `git mergetool` session has completed. Setting the `mergetool.keepBackup` configuration variable to `false` -causes `git mergetool` to automatically remove the backup as files +causes `git mergetool` to automatically remove the backup files as files are successfully merged. BACKEND SPECIFIC HINTS diff --git a/Documentation/git-mktree.txt b/Documentation/git-mktree.txt index 76b44f4da10387..383f09dd333f86 100644 --- a/Documentation/git-mktree.txt +++ b/Documentation/git-mktree.txt @@ -25,13 +25,13 @@ OPTIONS --missing:: Allow missing objects. The default behaviour (without this option) - is to verify that each tree entry's sha1 identifies an existing + is to verify that each tree entry's hash identifies an existing object. This option has no effect on the treatment of gitlink entries (aka "submodules") which are always allowed to be missing. --batch:: Allow building of more than one tree object before exiting. Each - tree is separated by a single blank line. The final new-line is + tree is separated by a single blank line. The final newline is optional. Note - if the `-z` option is used, lines are terminated with NUL. diff --git a/Documentation/git-range-diff.txt b/Documentation/git-range-diff.txt index 0b393715d70701..605a92e224eb7e 100644 --- a/Documentation/git-range-diff.txt +++ b/Documentation/git-range-diff.txt @@ -70,7 +70,7 @@ to revert to color all lines according to the outer diff markers Defaults to 60. Try a larger value if `git range-diff` erroneously considers a large change a total rewrite (deletion of one commit and addition of another), and a smaller one in the reverse case. - See the ``Algorithm`` section below for an explanation why this is + See the ``Algorithm`` section below for an explanation of why this is needed. --left-only:: diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index b09707474df0ec..32065318532451 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -25,7 +25,7 @@ fast-forward (i.e. 2-way) merge, or a 3-way merge, with the `-m` flag. When used with `-m`, the `-u` flag causes it to also update the files in the work tree with the result of the merge. -Trivial merges are done by 'git read-tree' itself. Only conflicting paths +Only trivial merges are done by 'git read-tree' itself. Only conflicting paths will be in unmerged state when 'git read-tree' returns. OPTIONS diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt index 88ea7e1cc01201..17d84f23c99e3b 100644 --- a/Documentation/git-remote-ext.txt +++ b/Documentation/git-remote-ext.txt @@ -82,7 +82,7 @@ begins with `ext::`. Examples: "ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'":: Like host.example:foo/repo, but use /home/foo/.ssh/somekey as - keypair and user as user on remote side. This avoids needing to + keypair and user as user on remote side. This avoids the need to edit .ssh/config. "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo":: diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index 4017157949e6d7..cbc0ece61e37c0 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -165,7 +165,7 @@ depth is 4095. Exclude the given pack from repacking. This is the equivalent of having `.keep` file on the pack. `` is the pack file name without leading directory (e.g. `pack-123.pack`). - The option could be specified multiple times to keep multiple + The option can be specified multiple times to keep multiple packs. --unpack-unreachable=:: diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index c70444705b545f..ad546a37cffa88 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -105,7 +105,7 @@ in linkgit:git-checkout[1] for details. specified. Unmerged paths on the working tree are left alone. --ignore-skip-worktree-bits:: - In sparse checkout mode, by default is to only update entries + In sparse checkout mode, the default is to only update entries matched by `` and sparse patterns in $GIT_DIR/info/sparse-checkout. This option ignores the sparse patterns and unconditionally restores any files in diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index 51029a22715cb3..fbe913ee746d3c 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -17,7 +17,7 @@ DESCRIPTION :git-rev-list: 1 include::rev-list-description.txt[] -'rev-list' is a very essential Git command, since it +'rev-list' is an essential Git command, since it provides the ability to build and traverse commit ancestry graphs. For this reason, it has a lot of different options that enables it to be used by commands as different as 'git bisect' and diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 6a4968f68a3c9d..2294e9a519a8d2 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -36,7 +36,7 @@ Each of these options must appear first on the command line. --sq-quote:: Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE section below). In contrast to the `--sq` option below, this - mode does only quoting. Nothing else is done to command input. + mode only does quoting. Nothing else is done to command input. Options for --parseopt ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 492a82323dab8e..e90d041817e76c 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -468,8 +468,8 @@ Information --dump-aliases:: Instead of the normal operation, dump the shorthand alias names from - the configured alias file(s), one per line in alphabetical order. Note, - this only includes the alias name and not its expanded email addresses. + the configured alias file(s), one per line in alphabetical order. Note + that this only includes the alias name and not its expanded email addresses. See 'sendemail.aliasesfile' for more information about aliases. diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index 595b002152fda5..e76c262d7f9710 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -55,7 +55,7 @@ be in a separate packet, and the list must end with a flush packet. --force:: Usually, the command refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it. - This flag disables the check. What this means is that + This flag disables the check. This means that the remote repository can lose commits; use it with care. @@ -117,7 +117,7 @@ When one or more '' are specified explicitly (whether on the command line or via `--stdin`), it can be either a single pattern, or a pair of such pattern separated by a colon ":" (this means that a ref name cannot have a colon in it). A -single pattern '' is just a shorthand for ':'. +single pattern '' is just shorthand for ':'. Each pattern pair consists of the source side (before the colon) and the destination side (after the colon). The ref to be @@ -143,9 +143,9 @@ name. See linkgit:git-rev-parse[1]. Without `--force`, the ref is stored at the remote only if does not exist, or is a proper subset (i.e. an -ancestor) of . This check, known as "fast-forward check", -is performed in order to avoid accidentally overwriting the -remote ref and lose other peoples' commits from there. +ancestor) of . This check, known as the "fast-forward check", +is performed to avoid accidentally overwriting the +remote ref and losing other people's commits from there. With `--force`, the fast-forward check is disabled for all refs. diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index b27d127b5e24f2..51f38218f0d7eb 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -251,7 +251,7 @@ Submodules have more state and instead report m the submodule has modified content ? the submodule has untracked files -since modified content or untracked files in a submodule cannot be added +This is since modified content or untracked files in a submodule cannot be added via `git add` in the superproject to prepare a commit. 'm' and '?' are applied recursively. For example if a nested submodule diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt index 2438f76da05ebf..3dc630da4b708a 100644 --- a/Documentation/git-stripspace.txt +++ b/Documentation/git-stripspace.txt @@ -41,7 +41,7 @@ OPTIONS -c:: --comment-lines:: - Prepend comment character and blank to each line. Lines will automatically + Prepend the comment character and a blank space to each line. Lines will automatically be terminated with a newline. On empty lines, only the comment character will be prepended. diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index c38fb3968bcabc..0680568dfda732 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -19,7 +19,7 @@ no value. OPTIONS ------- -l:: - Cause the logical variables to be listed. In addition, all the + Display the logical variables. In addition, all the variables of the Git configuration file .git/config are listed as well. (However, the configuration variables listing functionality is deprecated in favor of `git config -l`.) diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index 8b63ceb00e71a5..5cbb31f33e3d76 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -20,7 +20,7 @@ New users are encouraged to use linkgit:git-log[1] instead. The `whatchanged` command is essentially the same as linkgit:git-log[1] but defaults to show the raw format diff output and to skip merges. -The command is kept primarily for historical reasons; fingers of +The command is primarily kept for historical reasons; fingers of many people who learned Git long before `git log` was invented by reading Linux kernel mailing list are trained to type it. diff --git a/Documentation/gitformat-bundle.txt b/Documentation/gitformat-bundle.txt index 00e0a20e657196..f1acf196e100ce 100644 --- a/Documentation/gitformat-bundle.txt +++ b/Documentation/gitformat-bundle.txt @@ -86,10 +86,10 @@ In the bundle format, there can be a comment following a prerequisite obj-id. This is a comment and it has no specific meaning. The writer of the bundle MAY put any string here. The reader of the bundle MUST ignore the comment. -Note on the shallow clone and a Git bundle -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Note on shallow clones and Git bundles +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Note that the prerequisites does not represent a shallow-clone boundary. The +Note that the prerequisites do not represent a shallow-clone boundary. The semantics of the prerequisites and the shallow-clone boundaries are different, and the Git bundle v2 format cannot represent a shallow clone repository. diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 86f804720ae71f..63eb030b34de97 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -345,7 +345,7 @@ for the user. The default 'update' hook, when enabled--and with `hooks.allowunannotated` config option unset or set to false--prevents -unannotated tags to be pushed. +unannotated tags from being pushed. [[proc-receive]] proc-receive diff --git a/Documentation/gitprotocol-capabilities.txt b/Documentation/gitprotocol-capabilities.txt index 0fb5ea0c1ca754..5d5e39a7039e0b 100644 --- a/Documentation/gitprotocol-capabilities.txt +++ b/Documentation/gitprotocol-capabilities.txt @@ -61,8 +61,8 @@ complete cut across the DAG, or the client has said "done". Without multi_ack, a client sends have lines in --date-order until the server has found a common base. That means the client will send have lines that are already known by the server to be common, because -they overlap in time with another branch that the server hasn't found -a common base on yet. +they overlap in time with another branch on which the server hasn't found +a common base yet. For example suppose the client has commits in caps that the server 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. side-band, side-band-64k ------------------------ -This capability means that server can send, and client understand multiplexed +This capability means that the server can send, and the client can understand, multiplexed progress reports and error info interleaved with the packfile itself. 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 same deal, you have up to 65519 bytes of data and 1 byte for the stream code. -The client MUST send only maximum of one of "side-band" and "side- -band-64k". Server MUST diagnose it as an error if client requests +The client MUST send only one of "side-band" and "side- +band-64k". The server MUST diagnose it as an error if client requests both. ofs-delta --------- -Server can send, and client understand PACKv2 with delta referring to +The server can send, and the client can understand, PACKv2 with delta referring to its base by position in pack rather than by an obj-id. That is, they can send/read OBJ_OFS_DELTA (aka type 6) in a packfile. @@ -252,7 +252,7 @@ the current shallow boundary, instead of the depth from remote refs. no-progress ----------- -The client was started with "git clone -q" or something, and doesn't +The client was started with "git clone -q" or something similar, and doesn't want that side band 2. Basically the client just says "I do not wish to receive stream 2 on sideband, so do not send it to me, and if you did, I will drop it on the floor anyway". However, the sideband diff --git a/Documentation/gitprotocol-http.txt b/Documentation/gitprotocol-http.txt index ccc13f0a40758a..fcc2b25ee9f6b3 100644 --- a/Documentation/gitprotocol-http.txt +++ b/Documentation/gitprotocol-http.txt @@ -379,7 +379,7 @@ C: Place any object seen into set `advertised`. C: Build an empty set, `common`, to hold the objects that are later determined to be on both ends. -C: Build a set, `want`, of the objects from `advertised` the client +C: Build a set, `want`, of the objects from `advertised` that the client wants to fetch, based on what it saw during ref discovery. 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 negotiated through the `object-format` capability (default SHA-1). The `have` list is created by popping the first 32 commits -from `c_pending`. Less can be supplied if `c_pending` empties. +from `c_pending`. Fewer can be supplied if `c_pending` empties. If the client has sent 256 "have" commits and has not yet received one of those back from `s_common`, or the client has diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt index af6bf3c45ec1b7..bb9cbad7f3feaa 100644 --- a/Documentation/gitweb.txt +++ b/Documentation/gitweb.txt @@ -20,13 +20,13 @@ Gitweb provides a web interface to Git repositories. Its features include: * Browsing every revision of the repository. * Viewing the contents of files in the repository at any revision. * Viewing the revision log of branches, history of files and directories, - see what was changed when, by who. + seeing what was changed, when, and by whom. * Viewing the blame/annotation details of any file (if enabled). * Generating RSS and Atom feeds of commits, for any branch. The feeds are auto-discoverable in modern web browsers. * Viewing everything that was changed in a revision, and step through revisions one at a time, viewing the history of the repository. -* Finding commits which commit messages matches given search term. +* Finding commits whose commit messages match a given search term. See http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/[] for gitweb source code, browsed using gitweb itself. diff --git a/Documentation/howto/maintain-git.txt b/Documentation/howto/maintain-git.txt index d07c6d44e53c3b..29c473e5e04568 100644 --- a/Documentation/howto/maintain-git.txt +++ b/Documentation/howto/maintain-git.txt @@ -104,7 +104,7 @@ by doing the following: files in mbox format). - Write his own patches to address issues raised on the list but - nobody has stepped up solving. Send it out just like other + nobody has stepped up to solve. Send it out just like other contributors do, and pick them up just like patches from other contributors (see above). @@ -417,7 +417,7 @@ are merged together, the reference to the variable newly added by the latter topic will still use the old name in the result. The Meta/Reintegrate script that is used by redo-jch and redo-seen -scripts implements a crude but usable way to work this issue around. +scripts implements a crude but usable way to work around this issue. When the script merges branch $X, it checks if "refs/merge-fix/$X" exists, and if so, the effect of it is squashed into the result of the mechanical merge. In other words, diff --git a/Documentation/howto/using-merge-subtree.txt b/Documentation/howto/using-merge-subtree.txt index a499a94ac2289a..3bd581ac3591b6 100644 --- a/Documentation/howto/using-merge-subtree.txt +++ b/Documentation/howto/using-merge-subtree.txt @@ -11,7 +11,7 @@ Message-ID: How to use the subtree merge strategy ===================================== -There are situations where you want to include contents in your project +There are situations where you want to include content in your project from an independently developed project. You can just pull from the other project as long as there are no conflicting paths. diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt index 6c6baeeeb75bd8..0efb1153d27f52 100644 --- a/Documentation/i18n.txt +++ b/Documentation/i18n.txt @@ -46,7 +46,7 @@ mind. ------------ + Commit objects created with the above setting record the value -of `i18n.commitEncoding` in its `encoding` header. This is to +of `i18n.commitEncoding` in their `encoding` header. This is to help other people who look at them later. Lack of this header implies that the commit log message is encoded in UTF-8. diff --git a/Documentation/mergetools/vimdiff.txt b/Documentation/mergetools/vimdiff.txt index 2d631e9b1f242f..c36c5479392b22 100644 --- a/Documentation/mergetools/vimdiff.txt +++ b/Documentation/mergetools/vimdiff.txt @@ -32,10 +32,10 @@ have special meaning: - `+` is used to "open a new tab" - `,` is used to "open a new vertical split" - `/` is used to "open a new horizontal split" - - `@` is used to indicate which is the file containing the final version after + - `@` is used to indicate the file containing the final version after solving the conflicts. If not present, `MERGED` will be used by default. -The precedence of the operators is this one (you can use parentheses to change +The precedence of the operators is as follows (you can use parentheses to change it): `@` > `+` > `/` > `,` diff --git a/Documentation/technical/api-simple-ipc.txt b/Documentation/technical/api-simple-ipc.txt index d44ada98e7db9c..6c127b5dddf059 100644 --- a/Documentation/technical/api-simple-ipc.txt +++ b/Documentation/technical/api-simple-ipc.txt @@ -102,4 +102,4 @@ stateless request, receive an application-specific response, and disconnect. It is a one round trip facility for querying the server. The Simple-IPC routines hide the socket, named pipe, and thread pool details and allow the application -layer to focus on the application at hand. +layer to focus on the task at hand. diff --git a/Documentation/technical/bitmap-format.txt b/Documentation/technical/bitmap-format.txt index c2e652b71a7f69..687c58cebcc01d 100644 --- a/Documentation/technical/bitmap-format.txt +++ b/Documentation/technical/bitmap-format.txt @@ -114,7 +114,7 @@ result in an empty bitmap (no bits set). * N entries with compressed bitmaps, one for each indexed commit + -Where `N` is the total amount of entries in this bitmap index. +Where `N` is the total number of entries in this bitmap index. Each entry contains the following: ** {empty} diff --git a/Documentation/technical/parallel-checkout.txt b/Documentation/technical/parallel-checkout.txt index 47c9b6183cfad0..91a5eb26efd157 100644 --- a/Documentation/technical/parallel-checkout.txt +++ b/Documentation/technical/parallel-checkout.txt @@ -185,7 +185,7 @@ quite straightforward: for each parallel-eligible entry, the main process must remove all files that prevent this entry from being written (before enqueueing it). This includes any non-directory file in the leading path of the entry. Later, when a worker gets assigned the entry, -it looks again for the non-directories files and for an already existing +it looks again for the non-directory files and for an already existing file at the entry's path. If any of these checks finds something, the worker knows that there was a path collision. diff --git a/Documentation/technical/partial-clone.txt b/Documentation/technical/partial-clone.txt index 92fcee2bfffff8..b01cff6912a1c1 100644 --- a/Documentation/technical/partial-clone.txt +++ b/Documentation/technical/partial-clone.txt @@ -265,7 +265,7 @@ Future Work - Improve the way to specify the order in which promisor remotes are tried. + -For example this could allow to specify explicitly something like: +For example this could allow specifying explicitly something like: "When fetching from this remote, I want to use these promisor remotes in this order, though, when pushing or fetching to that remote, I want to use those promisor remotes in that order." diff --git a/Documentation/technical/racy-git.txt b/Documentation/technical/racy-git.txt index ceda4bbfda4d27..783e87e6aa4d7e 100644 --- a/Documentation/technical/racy-git.txt +++ b/Documentation/technical/racy-git.txt @@ -165,9 +165,9 @@ Avoiding runtime penalty In order to avoid the above runtime penalty, post 1.4.2 Git used to have a code that made sure the index file -got timestamp newer than the youngest files in the index when -there are many young files with the same timestamp as the -resulting index file would otherwise would have by waiting +got a timestamp newer than the youngest files in the index when +there were many young files with the same timestamp as the +resulting index file otherwise would have by waiting before finishing writing the index file out. I suspected that in practice the situation where many paths in the diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt index 6a67cc4174f820..d7d066d876a1e0 100644 --- a/Documentation/technical/reftable.txt +++ b/Documentation/technical/reftable.txt @@ -115,7 +115,7 @@ Varint encoding Varint encoding is identical to the ofs-delta encoding method used within pack files. -Decoder works such as: +Decoder works as follows: .... val = buf[ptr] & 0x7f diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 1c229d758152b6..4e79c1589ece05 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -6,9 +6,9 @@ address of the remote server, and the path to the repository. Depending on the transport protocol, some of this information may be absent. -Git supports ssh, git, http, and https protocols (in addition, ftp, +Git supports ssh, git, http, and https protocols (in addition, ftp and ftps can be used for fetching, but this is inefficient and -deprecated; do not use it). +deprecated; do not use them). The native transport (i.e. git:// URL) does no authentication and should be used with caution on unsecured networks. From 82e81edf718302c20c37b17a69a768bc36837a72 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:04 +0000 Subject: [PATCH 02/25] documentation: fix small error Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/fsck.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt index fec3eefb5b8f37..9b16757553068f 100644 --- a/Documentation/config/fsck.txt +++ b/Documentation/config/fsck.txt @@ -11,7 +11,7 @@ to clone or fetch it set `fetch.fsck.`. + The rest of the documentation discusses `fsck.*` for brevity, but the same applies for the corresponding `receive.fsck.*` and -`fetch..*`. variables. +`fetch.fsck.*`. variables. + Unlike variables like `color.ui` and `core.editor` the `receive.fsck.` and `fetch.fsck.` variables will not From 384f7d17d2f0d0ca689d8dda16f752c75a8ac634 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:05 +0000 Subject: [PATCH 03/25] documentation: fix typos Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/fsck-msgids.txt | 2 +- Documentation/git-get-tar-commit-id.txt | 2 +- Documentation/git-grep.txt | 2 +- Documentation/git-upload-pack.txt | 2 +- Documentation/gitformat-chunk.txt | 2 +- Documentation/gitformat-pack.txt | 4 ++-- Documentation/gitprotocol-capabilities.txt | 2 +- Documentation/technical/commit-graph.txt | 2 +- Documentation/technical/parallel-checkout.txt | 4 ++-- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/fsck-msgids.txt b/Documentation/fsck-msgids.txt index 09b0aecbf86688..8505c244bcf5bd 100644 --- a/Documentation/fsck-msgids.txt +++ b/Documentation/fsck-msgids.txt @@ -174,7 +174,7 @@ (FATAL) Missing end-of-line in the object header. `zeroPaddedDate`:: - (ERROR) Found a zero padded date in an author/commiter line. + (ERROR) Found a zero padded date in an author/committer line. `zeroPaddedFilemode`:: (WARN) Found a zero padded filemode in a tree. diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt index ac44d85b0b5c7f..b537bb45b138f4 100644 --- a/Documentation/git-get-tar-commit-id.txt +++ b/Documentation/git-get-tar-commit-id.txt @@ -20,7 +20,7 @@ and extract the commit ID stored in it. It reads only the first 1024 bytes of input, thus its runtime is not influenced by the size of the tar archive very much. -If no commit ID is found, 'git get-tar-commit-id' quietly exists with a +If no commit ID is found, 'git get-tar-commit-id' quietly exits with a return code of 1. This can happen if the archive had not been created using 'git archive' or if the first parameter of 'git archive' had been a tree ID instead of a commit ID or tag. diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index dabdbe8471de5d..0d0103c780af8c 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -337,7 +337,7 @@ The `--threads` option (and the grep.threads configuration) will be ignored when When grepping the object store (with `--cached` or giving tree objects), running with multiple threads might perform slower than single threaded if `--textconv` -is given and there're too many text conversions. So if you experience low +is given and there are too many text conversions. So if you experience low performance in this case, it might be desirable to use `--threads=1`. CONFIGURATION diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt index b656b4756752f6..7ad60bc3485bc8 100644 --- a/Documentation/git-upload-pack.txt +++ b/Documentation/git-upload-pack.txt @@ -26,7 +26,7 @@ OPTIONS ------- --[no-]strict:: - Do not try /.git/ if is no Git directory. + Do not try /.git/ if is not a Git directory. --timeout=:: Interrupt transfer after seconds of inactivity. diff --git a/Documentation/gitformat-chunk.txt b/Documentation/gitformat-chunk.txt index 57202ede273ad2..76ea678398a3f2 100644 --- a/Documentation/gitformat-chunk.txt +++ b/Documentation/gitformat-chunk.txt @@ -42,7 +42,7 @@ Each row consists of a 4-byte chunk identifier (ID) and an 8-byte offset. Each integer is stored in network-byte order. The chunk identifier `ID[i]` is a label for the data stored within this -fill from `OFFSET[i]` (inclusive) to `OFFSET[i+1]` (exclusive). Thus, the +file from `OFFSET[i]` (inclusive) to `OFFSET[i+1]` (exclusive). Thus, the size of the `i`th chunk is equal to the difference between `OFFSET[i+1]` and `OFFSET[i]`. This requires that the chunk data appears contiguously in the same order as the table of contents. diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt index 870e00f2982f31..fb3f8fcf56ba00 100644 --- a/Documentation/gitformat-pack.txt +++ b/Documentation/gitformat-pack.txt @@ -17,8 +17,8 @@ $GIT_DIR/objects/pack/multi-pack-index DESCRIPTION ----------- -The Git pack format is now Git stores most of its primary repository -data. Over the lietime af a repository loose objects (if any) and +The Git pack format is how Git stores most of its primary repository +data. Over the lifetime of a repository loose objects (if any) and smaller packs are consolidated into larger pack(s). See linkgit:git-gc[1] and linkgit:git-pack-objects[1]. diff --git a/Documentation/gitprotocol-capabilities.txt b/Documentation/gitprotocol-capabilities.txt index 5d5e39a7039e0b..9adda577e512d0 100644 --- a/Documentation/gitprotocol-capabilities.txt +++ b/Documentation/gitprotocol-capabilities.txt @@ -273,7 +273,7 @@ request include-tag only has to do with the client's desires for tag data, whether or not a server had advertised objects in the refs/tags/* namespace. -Servers MUST pack the tags if their referrant is packed and the client +Servers MUST pack the tags if their referent is packed and the client has requested include-tags. Clients MUST be prepared for the case where a server has ignored diff --git a/Documentation/technical/commit-graph.txt b/Documentation/technical/commit-graph.txt index 86fed0de0f77f9..2c26e95e51ab9a 100644 --- a/Documentation/technical/commit-graph.txt +++ b/Documentation/technical/commit-graph.txt @@ -136,7 +136,7 @@ Design Details - Commit grafts and replace objects can change the shape of the commit history. The latter can also be enabled/disabled on the fly using - `--no-replace-objects`. This leads to difficultly storing both possible + `--no-replace-objects`. This leads to difficulty storing both possible interpretations of a commit id, especially when computing generation numbers. The commit-graph will not be read or written when replace-objects or grafts are present. diff --git a/Documentation/technical/parallel-checkout.txt b/Documentation/technical/parallel-checkout.txt index 91a5eb26efd157..1a5fe09b51d9fb 100644 --- a/Documentation/technical/parallel-checkout.txt +++ b/Documentation/technical/parallel-checkout.txt @@ -148,7 +148,7 @@ information, the main process handles the results in two steps: - First, it updates the in-memory index with the `lstat()` information sent by the workers. (This must be done first as this information - might me required in the following step.) + might be required in the following step.) - Then it writes the items which collided on disk (i.e. items marked with `PC_ITEM_COLLIDED`). More on this below. @@ -232,7 +232,7 @@ conversion and re-encoding, are eligible for parallel checkout. Ineligible entries are checked out by the classic sequential codepath *before* spawning workers. -Note: submodules's files are also eligible for parallel checkout (as +Note: submodules' files are also eligible for parallel checkout (as long as they don't fall into any of the excluding categories mentioned above). But since each submodule is checked out in its own child process, we don't mix the superproject's and the submodules' files in From dbe33c5ad02aa9a6141abccf0821b49c46df2891 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:06 +0000 Subject: [PATCH 04/25] documentation: fix apostrophe usage Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/index.txt | 2 +- Documentation/config/pack.txt | 2 +- Documentation/config/submodule.txt | 2 +- Documentation/git-mktag.txt | 2 +- Documentation/git-rm.txt | 2 +- Documentation/gitprotocol-pack.txt | 2 +- Documentation/pull-fetch-param.txt | 2 +- Documentation/technical/rerere.txt | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/config/index.txt b/Documentation/config/index.txt index 23c7985eb40974..3eff42036033ea 100644 --- a/Documentation/config/index.txt +++ b/Documentation/config/index.txt @@ -23,7 +23,7 @@ index.threads:: Specifies the number of threads to spawn when loading the index. This is meant to reduce index load time on multiprocessor machines. Specifying 0 or 'true' will cause Git to auto-detect the number of - CPU's and set the number of threads accordingly. Specifying 1 or + CPUs and set the number of threads accordingly. Specifying 1 or 'false' will disable multithreading. Defaults to 'true'. index.version:: diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.txt index dcd4c871b3a1b9..6308f21e03d5f7 100644 --- a/Documentation/config/pack.txt +++ b/Documentation/config/pack.txt @@ -74,7 +74,7 @@ pack.threads:: warning. This is meant to reduce packing time on multiprocessor machines. The required amount of memory for the delta search window is however multiplied by the number of threads. - Specifying 0 will cause Git to auto-detect the number of CPU's + Specifying 0 will cause Git to auto-detect the number of CPUs and set the number of threads accordingly. pack.indexVersion:: diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt index 665419fa13586b..0672d9911724d1 100644 --- a/Documentation/config/submodule.txt +++ b/Documentation/config/submodule.txt @@ -35,7 +35,7 @@ submodule..ignore:: a submodule as modified. When set to "all", it will never be considered modified (but it will nonetheless show up in the output of status and commit when it has been staged), "dirty" will ignore all changes - to the submodules work tree and + to the submodule's work tree and takes only differences between the HEAD of the submodule and the commit recorded in the superproject into account. "untracked" will additionally let submodules with modified tracked files in their work tree show up. diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index b2a2e80d42143a..cd8fe9169e87c8 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- -Reads a tag contents on standard input and creates a tag object. The +Reads a tag's contents on standard input and creates a tag object. The output is the new tag's identifier. This command is mostly equivalent to linkgit:git-hash-object[1] diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index 81bc23f3cdbb56..363a26934f54e0 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -163,7 +163,7 @@ will be staged (unless --cached or -n are used). A submodule is considered up to date when the HEAD is the same as recorded in the index, no tracked files are modified and no untracked -files that aren't ignored are present in the submodules work tree. +files that aren't ignored are present in the submodule's work tree. Ignored files are deemed expendable and won't stop a submodule's work tree from being removed. diff --git a/Documentation/gitprotocol-pack.txt b/Documentation/gitprotocol-pack.txt index dd4108b7a3b954..01391cb300d5c7 100644 --- a/Documentation/gitprotocol-pack.txt +++ b/Documentation/gitprotocol-pack.txt @@ -137,7 +137,7 @@ an absolute path in the remote filesystem. v ssh user@example.com "git-upload-pack '/project.git'" -In a "user@host:path" format URI, its relative to the user's home +In a "user@host:path" format URI, it's relative to the user's home directory, because the Git client will run: git clone user@example.com:project.git diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index 95a7390b2c78bd..26bf06d991b907 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -71,7 +71,7 @@ refspec (or `--force`). Unlike when pushing with linkgit:git-push[1], any updates outside of `refs/{tags,heads}/*` will be accepted without `+` in the refspec (or `--force`), whether that's swapping e.g. a tree object for a blob, or -a commit for another commit that's doesn't have the previous commit as +a commit for another commit that doesn't have the previous commit as an ancestor etc. + Unlike when pushing with linkgit:git-push[1], there is no diff --git a/Documentation/technical/rerere.txt b/Documentation/technical/rerere.txt index be58f1bee36894..3f9259cb1e4af0 100644 --- a/Documentation/technical/rerere.txt +++ b/Documentation/technical/rerere.txt @@ -76,7 +76,7 @@ examples would both result in the following normalized conflict: Sorting hunks ~~~~~~~~~~~~~ -As before, lets imagine that a common ancestor had a file with line A +As before, let's imagine that a common ancestor had a file with line A its early part, and line X in its late part. And then four branches are forked that do these things: From 89363522424a27b2e43c74a7965566d943cbdba4 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:07 +0000 Subject: [PATCH 05/25] documentation: add missing words Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/advice.txt | 2 +- Documentation/config/checkout.txt | 2 +- Documentation/config/http.txt | 2 +- Documentation/config/mergetool.txt | 2 +- Documentation/config/sendemail.txt | 2 +- Documentation/git-checkout.txt | 2 +- Documentation/git-credential-cache.txt | 2 +- Documentation/git-credential-store.txt | 2 +- Documentation/git-difftool.txt | 2 +- Documentation/git-fetch-pack.txt | 2 +- Documentation/git-mktag.txt | 2 +- Documentation/git-prune-packed.txt | 2 +- Documentation/git-restore.txt | 2 +- Documentation/gitprotocol-v2.txt | 2 +- Documentation/howto/use-git-daemon.txt | 2 +- Documentation/technical/api-simple-ipc.txt | 2 +- Documentation/technical/partial-clone.txt | 2 +- Documentation/technical/racy-git.txt | 2 +- Documentation/technical/rerere.txt | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index c548a91e6761c7..f4864a2d58b8fa 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt @@ -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 diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt index bfbca90f0e90bd..a54faab238a534 100644 --- a/Documentation/config/checkout.txt +++ b/Documentation/config/checkout.txt @@ -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. diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt index 1d805fdddbce61..2d4e0c9b869b56 100644 --- a/Documentation/config/http.txt +++ b/Documentation/config/http.txt @@ -254,7 +254,7 @@ http.lowSpeedLimit, http.lowSpeedTime:: http.noEPSV:: A boolean which disables using of EPSV ftp command by curl. - This can helpful with some "poor" ftp servers which don't + This can be helpful with some "poor" ftp servers which don't support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV` environment variable. Default is false (curl will use EPSV). diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.txt index e9abde9d60c3d7..fe4ba0271b5bc9 100644 --- a/Documentation/config/mergetool.txt +++ b/Documentation/config/mergetool.txt @@ -22,7 +22,7 @@ mergetool..trustExitCode:: For a custom merge command, specify whether the exit code of the merge command can be used to determine whether the merge was successful. If this is not set to true then the merge target file - timestamp is checked and the merge assumed to have been successful + timestamp is checked and the merge is assumed to have been successful if the file has been updated, otherwise the user is prompted to indicate the success of the merge. diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.txt index 92a9ebe98c63e5..51b1b5fe7e3334 100644 --- a/Documentation/config/sendemail.txt +++ b/Documentation/config/sendemail.txt @@ -91,7 +91,7 @@ sendemail.smtpBatchSize:: See also the `--batch-size` option of linkgit:git-send-email[1]. sendemail.smtpReloginDelay:: - Seconds wait before reconnecting to smtp server. + Seconds to wait before reconnecting to smtp server. See also the `--relogin-delay` option of linkgit:git-send-email[1]. sendemail.forbidSendmailVariables:: diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index a30e3ebc51fbe9..240c54639e8e85 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -43,7 +43,7 @@ $ git checkout -b --track / You could omit ``, in which case the command degenerates to "check out the current branch", which is a glorified no-op with rather expensive side-effects to show only the tracking information, -if exists, for the current branch. +if it exists, for the current branch. 'git checkout' -b|-B []:: diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt index f473994a864e95..487cc557a87fea 100644 --- a/Documentation/git-credential-cache.txt +++ b/Documentation/git-credential-cache.txt @@ -16,7 +16,7 @@ DESCRIPTION This command caches credentials for use by future Git programs. The stored credentials are kept in memory of the cache-daemon -process (instead of written to a file) and are forgotten after a +process (instead of being written to a file) and are forgotten after a configurable timeout. Credentials are forgotten sooner if the cache-daemon dies, for example if the system restarts. The cache is accessible over a Unix domain socket, restricted to the current diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt index 76b0798856336f..71864a872642e8 100644 --- a/Documentation/git-credential-store.txt +++ b/Documentation/git-credential-store.txt @@ -33,7 +33,7 @@ OPTIONS Use `` to lookup and store credentials. The file will have its filesystem permissions set to prevent other users on the system - from reading it, but will not be encrypted or otherwise + from reading it, but it will not be encrypted or otherwise protected. If not specified, credentials will be searched for from `~/.git-credentials` and `$XDG_CONFIG_HOME/git/credentials`, and credentials will be written to `~/.git-credentials` if it exists, or diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt index ac0ac6fa02205a..179e5ae216231d 100644 --- a/Documentation/git-difftool.txt +++ b/Documentation/git-difftool.txt @@ -78,7 +78,7 @@ with custom merge tool commands and has the same value as `$MERGED`. Print a list of diff tools that may be used with `--tool`. --[no-]symlinks:: - 'git difftool''s default behavior is create symlinks to the + 'git difftool''s default behavior is to create symlinks to the working tree when run in `--dir-diff` mode and the right-hand side of the comparison yields the same content as the file in the working tree. diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt index 46747d5f429164..b3467664d30bde 100644 --- a/Documentation/git-fetch-pack.txt +++ b/Documentation/git-fetch-pack.txt @@ -69,7 +69,7 @@ be in a separate packet, and the list must end with a flush packet. --upload-pack=:: Use this to specify the path to 'git-upload-pack' on the - remote side, if is not found on your $PATH. + remote side, if it is not found on your $PATH. Installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and your privately installed git may not be found on the system diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index cd8fe9169e87c8..7a01496234300f 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt @@ -27,7 +27,7 @@ write a tag found in `my-tag`: The difference is that mktag will die before writing the tag if the tag doesn't pass a linkgit:git-fsck[1] check. -The "fsck" check done mktag is stricter than what linkgit:git-fsck[1] +The "fsck" check done by mktag is stricter than what linkgit:git-fsck[1] would run by default in that all `fsck.` messages are promoted from warnings to errors (so e.g. a missing "tagger" line is an error). diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt index 844d6f808a0c2f..db742dcfeea84f 100644 --- a/Documentation/git-prune-packed.txt +++ b/Documentation/git-prune-packed.txt @@ -15,7 +15,7 @@ SYNOPSIS DESCRIPTION ----------- This program searches the `$GIT_OBJECT_DIRECTORY` for all objects that currently -exist in a pack file as well as the independent object directories. +exist in a pack file as well as in the independent object directories. All such extra objects are removed. diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index ad546a37cffa88..975825b44aa4d0 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -199,7 +199,7 @@ the same as using linkgit:git-reset[1]) $ git restore --staged hello.c ------------ -or you can restore both the index and the working tree (this the same +or you can restore both the index and the working tree (this is the same as using linkgit:git-checkout[1]) ------------ diff --git a/Documentation/gitprotocol-v2.txt b/Documentation/gitprotocol-v2.txt index acb97ad0c22440..8c1e7c61eac751 100644 --- a/Documentation/gitprotocol-v2.txt +++ b/Documentation/gitprotocol-v2.txt @@ -29,7 +29,7 @@ protocol. Protocol v2 will improve upon v1 in the following ways: semantics the http remote helper can simply act as a proxy In protocol v2 communication is command oriented. When first contacting a -server a list of capabilities will advertised. Some of these capabilities +server a list of capabilities will be advertised. Some of these capabilities will be commands which a client can request be executed. Once a command has completed, a client can reuse the connection and request that other commands be executed. diff --git a/Documentation/howto/use-git-daemon.txt b/Documentation/howto/use-git-daemon.txt index 7af2e52cf312c4..2cad9b3ca5366f 100644 --- a/Documentation/howto/use-git-daemon.txt +++ b/Documentation/howto/use-git-daemon.txt @@ -4,7 +4,7 @@ How to use git-daemon ===================== Git can be run in inetd mode and in stand alone mode. But all you want is -let a coworker pull from you, and therefore need to set up a Git server +to let a coworker pull from you, and therefore need to set up a Git server real quick, right? Note that git-daemon is not really chatty at the moment, especially when diff --git a/Documentation/technical/api-simple-ipc.txt b/Documentation/technical/api-simple-ipc.txt index 6c127b5dddf059..d88b1ef206efb6 100644 --- a/Documentation/technical/api-simple-ipc.txt +++ b/Documentation/technical/api-simple-ipc.txt @@ -20,7 +20,7 @@ IPC-client. The IPC-client routines within a client application process connect to the IPC-server and send a request message and wait for a response. -When received, the response is returned back the caller. +When received, the response is returned back to the caller. For example, the `fsmonitor--daemon` feature will be built as a server application on top of the IPC-server library routines. It will have diff --git a/Documentation/technical/partial-clone.txt b/Documentation/technical/partial-clone.txt index b01cff6912a1c1..1719c723f5cb60 100644 --- a/Documentation/technical/partial-clone.txt +++ b/Documentation/technical/partial-clone.txt @@ -3,7 +3,7 @@ Partial Clone Design Notes The "Partial Clone" feature is a performance optimization for Git that allows Git to function without having a complete copy of the repository. -The goal of this work is to allow Git better handle extremely large +The goal of this work is to allow Git to better handle extremely large repositories. During clone and fetch operations, Git downloads the complete contents diff --git a/Documentation/technical/racy-git.txt b/Documentation/technical/racy-git.txt index 783e87e6aa4d7e..02ae508d227c04 100644 --- a/Documentation/technical/racy-git.txt +++ b/Documentation/technical/racy-git.txt @@ -11,7 +11,7 @@ write out the next tree object to be committed. The state is "virtual" in the sense that it does not necessarily have to, and often does not, match the files in the working tree. -There are cases Git needs to examine the differences between the +There are cases where Git needs to examine the differences between the virtual working tree state in the index and the files in the working tree. The most obvious case is when the user asks `git diff` (or its low level implementation, `git diff-files`) or diff --git a/Documentation/technical/rerere.txt b/Documentation/technical/rerere.txt index 3f9259cb1e4af0..5f4dd7c102827d 100644 --- a/Documentation/technical/rerere.txt +++ b/Documentation/technical/rerere.txt @@ -60,7 +60,7 @@ By resolving this conflict, to leave line D, the user declares: what AB and AC wanted to do. As branch AC2 refers to the same commit as AC, the above implies that -this is also compatible what AB and AC2 wanted to do. +this is also compatible with what AB and AC2 wanted to do. By extension, this means that rerere should recognize that the above conflicts are the same. To do this, the labels on the conflict From 859a6d6045e338a337cb7499100b1fa31c367fbf Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:08 +0000 Subject: [PATCH 06/25] documentation: remove extraneous words Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/branch.txt | 2 +- Documentation/config/gpg.txt | 2 +- Documentation/config/log.txt | 2 +- Documentation/config/sendemail.txt | 2 +- Documentation/diff-generate-patch.txt | 2 +- Documentation/git-diff-tree.txt | 2 +- Documentation/git-fsmonitor--daemon.txt | 2 +- Documentation/githooks.txt | 2 +- Documentation/gitprotocol-common.txt | 2 +- Documentation/gitprotocol-http.txt | 2 +- Documentation/pull-fetch-param.txt | 2 +- Documentation/technical/parallel-checkout.txt | 2 +- Documentation/technical/partial-clone.txt | 2 +- Documentation/technical/rerere.txt | 2 +- Documentation/urls-remotes.txt | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/Documentation/config/branch.txt b/Documentation/config/branch.txt index 2b05ed3574bf4a..3bec6daf71ab9f 100644 --- a/Documentation/config/branch.txt +++ b/Documentation/config/branch.txt @@ -64,7 +64,7 @@ branch..merge:: handled like the remote part of a refspec, and must match a ref which is fetched from the remote given by "branch..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. diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt index a31faab2edd94f..248d99d70b803a 100644 --- a/Documentation/config/gpg.txt +++ b/Documentation/config/gpg.txt @@ -38,7 +38,7 @@ gpg.minTrustLevel:: * `ultimate` gpg.ssh.defaultKeyCommand:: - This command that will be run when user.signingkey is not set and a ssh + This command will be run when user.signingkey is not set and a ssh signature is requested. On successful exit a valid ssh public key prefixed with `key::` is expected in the first line of its output. This allows for a script doing a dynamic lookup of the correct public diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt index 5f96cf87fb96ce..6e04fbe4f48810 100644 --- a/Documentation/config/log.txt +++ b/Documentation/config/log.txt @@ -9,7 +9,7 @@ log.date:: `--date` option. See linkgit:git-log[1] for details. + If the format is set to "auto:foo" and the pager is in use, format -"foo" will be the used for the date format. Otherwise "default" will +"foo" will be used for the date format. Otherwise "default" will be used. log.decorate:: diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.txt index 51b1b5fe7e3334..792e68a4456972 100644 --- a/Documentation/config/sendemail.txt +++ b/Documentation/config/sendemail.txt @@ -36,7 +36,7 @@ sendemail.aliasesFile:: sendemail.aliasFileType:: Format of the file(s) specified in sendemail.aliasesFile. Must be - one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'. + one of 'mutt', 'mailrc', 'pine', 'elm', 'gnus', or 'sendmail'. + What an alias file in each format looks like can be found in the documentation of the email program of the same name. The diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 55df903abd1aa7..49ad31fca2ab79 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -77,7 +77,7 @@ separate lines indicate the old and the new mode. 5. Hunk headers mention the name of the function to which the hunk applies. See "Defining a custom hunk-header" in - linkgit:gitattributes[5] for details of how to tailor to this to + linkgit:gitattributes[5] for details of how to tailor this to specific languages. diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 81caad5c95cedc..37ca32c396f382 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -104,7 +104,7 @@ include::pretty-options.txt[] This flag changes the way a merge commit patch is displayed, in a similar way to the `-c` option. It implies the `-c` and `-p` options and further compresses the patch output - by omitting uninteresting hunks whose the contents in the parents + by omitting uninteresting hunks whose contents in the parents have only two variants and the merge result picks one of them without modification. When all hunks are uninteresting, the commit itself and the commit log message is not shown, just like in any other diff --git a/Documentation/git-fsmonitor--daemon.txt b/Documentation/git-fsmonitor--daemon.txt index 8238eadb0e166a..f50a28b09f9cba 100644 --- a/Documentation/git-fsmonitor--daemon.txt +++ b/Documentation/git-fsmonitor--daemon.txt @@ -84,7 +84,7 @@ may or may not have the needed support; the fsmonitor daemon is not guaranteed to work with these filesystems and such use is considered experimental. By default, the socket is created in the `.git` directory, however, if the -`.git` directory is on a network-mounted filesystem, it will be instead be +`.git` directory is on a network-mounted filesystem, it will instead be created at `$HOME/.git-fsmonitor-*` unless `$HOME` itself is on a network-mounted filesystem in which case you must set the configuration variable `fsmonitor.socketDir` to the path of a directory on a Mac OS native diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 63eb030b34de97..34e2c656de3030 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -384,7 +384,7 @@ following example for the protocol, the letter 'S' stands for H: PKT-LINE(ok ) # NO, I reject it. H: PKT-LINE(ng ) - # Fall through, let 'receive-pack' to execute it. + # Fall through, let 'receive-pack' execute it. H: PKT-LINE(ok ) H: PKT-LINE(option fall-through) # OK, but has an alternate reference. The alternate reference name diff --git a/Documentation/gitprotocol-common.txt b/Documentation/gitprotocol-common.txt index 1486651bd1002f..cdc9d6e707586c 100644 --- a/Documentation/gitprotocol-common.txt +++ b/Documentation/gitprotocol-common.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -This document sets defines things common to various over-the-wire +This document defines things common to various over-the-wire protocols and file formats used in Git. ABNF Notation diff --git a/Documentation/gitprotocol-http.txt b/Documentation/gitprotocol-http.txt index fcc2b25ee9f6b3..21b73b7a1f5bd0 100644 --- a/Documentation/gitprotocol-http.txt +++ b/Documentation/gitprotocol-http.txt @@ -42,7 +42,7 @@ both the "smart" and "dumb" HTTP protocols used by Git operate by appending additional path components onto the end of the user supplied `$GIT_URL` string. -An example of a dumb client requesting for a loose object: +An example of a dumb client requesting a loose object: $GIT_URL: http://example.com:8080/git/repo.git URL request: http://example.com:8080/git/repo.git/objects/d0/49f6c27a2244e12041955e262a404c7faba355 diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index 26bf06d991b907..74143ef0d247ee 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -80,7 +80,7 @@ configuration which'll amend these rules, and nothing like a + As with pushing with linkgit:git-push[1], all of the rules described above about what's not allowed as an update can be overridden by -adding an the optional leading `+` to a refspec (or using `--force` +adding an optional leading `+` to a refspec (or using `--force` command line option). The only exception to this is that no amount of forcing will make the `refs/heads/*` namespace accept a non-commit object. diff --git a/Documentation/technical/parallel-checkout.txt b/Documentation/technical/parallel-checkout.txt index 1a5fe09b51d9fb..b5f54dcd4518fa 100644 --- a/Documentation/technical/parallel-checkout.txt +++ b/Documentation/technical/parallel-checkout.txt @@ -63,7 +63,7 @@ improvements over the sequential code, but there was still too much lock contention. A `perf` profiling indicated that around 20% of the runtime during a local Linux clone (on an SSD) was spent in locking functions. For this reason this approach was rejected in favor of using multiple -child processes, which led to a better performance. +child processes, which led to better performance. Multi-Process Solution ---------------------- diff --git a/Documentation/technical/partial-clone.txt b/Documentation/technical/partial-clone.txt index 1719c723f5cb60..29876ca582ae79 100644 --- a/Documentation/technical/partial-clone.txt +++ b/Documentation/technical/partial-clone.txt @@ -322,7 +322,7 @@ Footnotes [a] expensive-to-modify list of missing objects: Earlier in the design of partial clone we discussed the need for a single list of missing objects. - This would essentially be a sorted linear list of OIDs that the were + This would essentially be a sorted linear list of OIDs that were omitted by the server during a clone or subsequent fetches. This file would need to be loaded into memory on every object lookup. diff --git a/Documentation/technical/rerere.txt b/Documentation/technical/rerere.txt index 5f4dd7c102827d..580f23360a27bf 100644 --- a/Documentation/technical/rerere.txt +++ b/Documentation/technical/rerere.txt @@ -145,7 +145,7 @@ Nested conflicts Nested conflicts are handled very similarly to "simple" conflicts. Similar to simple conflicts, the conflict is first normalized by stripping the labels from conflict markers, stripping the common ancestor -version, and the sorting the conflict hunks, both for the outer and the +version, and sorting the conflict hunks, both for the outer and the inner conflict. This is done recursively, so any number of nested conflicts can be handled. diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt index ae8c2db427bb6a..3504afbf2e9652 100644 --- a/Documentation/urls-remotes.txt +++ b/Documentation/urls-remotes.txt @@ -33,7 +33,7 @@ config file would appear like this: ------------ The `` is used for pushes only. It is optional and defaults -to ``. Pushing to a remote affects all defined pushurls or to all +to ``. Pushing to a remote affects all defined pushurls or all defined urls if no pushurls are defined. Fetch, however, will only fetch from the first defined url if multiple urls are defined. From ce14cc0b00098201f967346955804abd774174ea Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:09 +0000 Subject: [PATCH 07/25] documentation: fix subject/verb agreement Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 2 +- Documentation/config/advice.txt | 2 +- Documentation/config/alias.txt | 2 +- Documentation/config/fsck.txt | 2 +- Documentation/config/gpg.txt | 2 +- Documentation/config/maintenance.txt | 2 +- Documentation/config/status.txt | 2 +- Documentation/fetch-options.txt | 2 +- Documentation/git-blame.txt | 2 +- Documentation/git-diff-tree.txt | 2 +- Documentation/git-format-patch.txt | 2 +- Documentation/git-fsck.txt | 4 ++-- Documentation/git-init.txt | 2 +- Documentation/git-rev-list.txt | 2 +- Documentation/git-show-ref.txt | 2 +- Documentation/git-symbolic-ref.txt | 2 +- Documentation/gitdiffcore.txt | 2 +- Documentation/gitformat-bundle.txt | 2 +- Documentation/gitprotocol-capabilities.txt | 2 +- Documentation/gitprotocol-pack.txt | 4 ++-- Documentation/glossary-content.txt | 2 +- Documentation/howto/coordinate-embargoed-releases.txt | 2 +- Documentation/i18n.txt | 2 +- Documentation/technical/api-simple-ipc.txt | 2 +- Documentation/technical/reftable.txt | 4 ++-- 25 files changed, 28 insertions(+), 28 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 99b22ff2345060..c494e07460ef26 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -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 diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index f4864a2d58b8fa..f524af4e899b94 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt @@ -5,7 +5,7 @@ advice.*:: + -- ambiguousFetchRefspec:: - Advice shown when fetch refspec for multiple remotes map to + Advice shown when fetch refspec for multiple remotes maps to the same remote-tracking branch namespace and causes branch tracking set-up to fail. fetchShowForcedUpdates:: diff --git a/Documentation/config/alias.txt b/Documentation/config/alias.txt index f1ca739d574293..01df96fab3df11 100644 --- a/Documentation/config/alias.txt +++ b/Documentation/config/alias.txt @@ -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 diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt index 9b16757553068f..0687e86ba10071 100644 --- a/Documentation/config/fsck.txt +++ b/Documentation/config/fsck.txt @@ -44,7 +44,7 @@ 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 + 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 diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt index 248d99d70b803a..5cf32b179dc8bd 100644 --- a/Documentation/config/gpg.txt +++ b/Documentation/config/gpg.txt @@ -25,7 +25,7 @@ gpg..program:: gpg.minTrustLevel:: Specifies a minimum trust level for signature verification. If this option is unset, then signature verification for merge - operations require a key with at least `marginal` trust. Other + operations requires a key with at least `marginal` trust. Other operations that perform signature verification require a key with at least `undefined` trust. Setting this option overrides the required trust-level for all operations. Supported values, diff --git a/Documentation/config/maintenance.txt b/Documentation/config/maintenance.txt index 18f056213145e5..69a4f05153e3ba 100644 --- a/Documentation/config/maintenance.txt +++ b/Documentation/config/maintenance.txt @@ -12,7 +12,7 @@ maintenance.strategy:: then that value is used instead of the one provided by `maintenance.strategy`. The possible strategy strings are: + -* `none`: This default setting implies no task are run at any schedule. +* `none`: This default setting implies no tasks are run at any schedule. * `incremental`: This setting optimizes for performing small maintenance activities that do not delete any data. This does not schedule the `gc` task, but runs the `prefetch` and `commit-graph` tasks hourly, the diff --git a/Documentation/config/status.txt b/Documentation/config/status.txt index 0fc704ab80b223..f0336938cbce25 100644 --- a/Documentation/config/status.txt +++ b/Documentation/config/status.txt @@ -47,7 +47,7 @@ status.showUntrackedFiles:: contain only untracked files, are shown with the directory name only. Showing untracked files means that Git needs to lstat() all the files in the whole repository, which might be slow on some - systems. So, this variable controls how the commands displays + systems. So, this variable controls how the commands display the untracked files. Possible values are: + -- diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt index 41fc7ca3c67f5d..9ee9fa659d2e03 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.txt @@ -43,7 +43,7 @@ the current repository has the same history as the source repository. --update-shallow:: By default when fetching from a shallow repository, `git fetch` refuses refs that require updating - .git/shallow. This option updates .git/shallow and accept such + .git/shallow. This option updates .git/shallow and accepts such refs. --negotiation-tip=:: diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index f69a871a96f758..a927c7c9f33b1b 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -128,7 +128,7 @@ at least once for each commit: - the filename in the commit that the line is attributed to. - the first line of the commit log message ("summary"). -The contents of the actual line is output after the above +The contents of the actual line are output after the above header, prefixed by a TAB. This is to allow adding more header elements later. diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 37ca32c396f382..1e34f80daa9145 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -107,7 +107,7 @@ include::pretty-options.txt[] by omitting uninteresting hunks whose contents in the parents have only two variants and the merge result picks one of them without modification. When all hunks are uninteresting, the commit - itself and the commit log message is not shown, just like in any other + itself and the commit log message are not shown, just like in any other "empty diff" case. --combined-all-paths:: diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 711823a7f4ef94..aaafce24be20c5 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -55,7 +55,7 @@ A "message" generated by the command consists of three parts: * The "patch", which is the "diff -p --stat" output (see linkgit:git-diff[1]) between the commit and its parent. -The log message and the patch is separated by a line with a +The log message and the patch are separated by a line with a three-dash line. There are two ways to specify which commits to operate on. diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index b6a0f8a085ca14..e4980d286151a7 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt @@ -64,7 +64,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs --connectivity-only:: Check only the connectivity of reachable objects, making sure that any objects referenced by a reachable tag, commit, or tree - is present. This speeds up the operation by avoiding reading + are present. This speeds up the operation by avoiding reading blobs entirely (though it does still check that referenced blobs exist). This will detect corruption in commits and trees, but 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. recorded with g+w bit set, which was created by older versions of Git. Existing repositories, including the Linux kernel, Git itself, and sparse repository have old - objects that triggers this check, but it is recommended + objects that trigger this check, but it is recommended to check new projects with this flag. --verbose:: diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 30ab86ab96a7cb..138dc4a3bfe962 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -115,7 +115,7 @@ Same as 'group', but make the repository readable by all users. '' is a 3-digit octal number prefixed with `0` and each file will have mode ''. '' will override users' umask(2) value (and not only loosen permissions as 'group' and 'all' -does). '0640' will create a repository which is group-readable, but +do). '0640' will create a repository which is group-readable, but not group-writable or accessible to others. '0660' will create a repo that is readable and writable to the current user and group, but inaccessible to others (directories and executable files get their diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index fbe913ee746d3c..2e05c4b510927a 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -19,7 +19,7 @@ include::rev-list-description.txt[] 'rev-list' is an essential Git command, since it provides the ability to build and traverse commit ancestry graphs. For -this reason, it has a lot of different options that enables it to be +this reason, it has a lot of different options that enable it to be used by commands as different as 'git bisect' and 'git repack'. diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index 2fe274b8faa6d3..36e81b9dec45c0 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -144,7 +144,7 @@ use: ----------------------------------------------------------------------------- This will show "refs/heads/master" but also "refs/remote/other-repo/master", -if such references exists. +if such references exist. When using the `--verify` flag, the command requires an exact path: diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt index 102c83eb19e98a..761b154bcbb58b 100644 --- a/Documentation/git-symbolic-ref.txt +++ b/Documentation/git-symbolic-ref.txt @@ -27,7 +27,7 @@ symbolic ref. A symbolic ref is a regular file that stores a string that begins with `ref: refs/`. For example, your `.git/HEAD` is -a regular file whose contents is `ref: refs/heads/master`. +a regular file whose content is `ref: refs/heads/master`. OPTIONS ------- diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 0d57f86abc4a51..5681ba3f3302c1 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -173,7 +173,7 @@ Note that when rename detection is on but both copy and break detection are off, rename detection adds a preliminary step that first checks if files are moved across directories while keeping their filename the same. If there is a file added to a directory whose -contents is sufficiently similar to a file with the same name that got +contents are sufficiently similar to a file with the same name that got deleted from a different directory, it will mark them as renames and exclude them from the later quadratic step (the one that pairwise compares all unmatched files to find the "best" matches, determined by diff --git a/Documentation/gitformat-bundle.txt b/Documentation/gitformat-bundle.txt index f1acf196e100ce..1b75cf71cec103 100644 --- a/Documentation/gitformat-bundle.txt +++ b/Documentation/gitformat-bundle.txt @@ -67,7 +67,7 @@ A Git bundle consists of several parts. * "Capabilities", which are only in the v3 format, indicate functionality that the bundle requires to be read properly. -* "Prerequisites" lists the objects that are NOT included in the bundle and the +* "Prerequisites" list the objects that are NOT included in the bundle and the reader of the bundle MUST already have, in order to use the data in the bundle. The objects stored in the bundle may refer to prerequisite objects and anything reachable from them (e.g. a tree object in the bundle can reference diff --git a/Documentation/gitprotocol-capabilities.txt b/Documentation/gitprotocol-capabilities.txt index 9adda577e512d0..388846d92e918e 100644 --- a/Documentation/gitprotocol-capabilities.txt +++ b/Documentation/gitprotocol-capabilities.txt @@ -30,7 +30,7 @@ to be in effect. The client MUST NOT ask for capabilities the server did not say it supports. Server MUST diagnose and abort if capabilities it does not understand -was sent. Server MUST NOT ignore capabilities that client requested +were sent. Server MUST NOT ignore capabilities that client requested and server advertised. As a consequence of these rules, server MUST NOT advertise capabilities it does not understand. diff --git a/Documentation/gitprotocol-pack.txt b/Documentation/gitprotocol-pack.txt index 01391cb300d5c7..837b691c892b31 100644 --- a/Documentation/gitprotocol-pack.txt +++ b/Documentation/gitprotocol-pack.txt @@ -30,7 +30,7 @@ pkt-line Format --------------- The descriptions below build on the pkt-line format described in -linkgit:gitprotocol-common[5]. When the grammar indicate `PKT-LINE(...)`, unless +linkgit:gitprotocol-common[5]. When the grammar indicates `PKT-LINE(...)`, unless otherwise noted the usual pkt-line LF rules apply: the sender SHOULD include a LF, but the receiver MUST NOT complain if it is not present. @@ -325,7 +325,7 @@ a positive depth, this step is skipped. If the client has requested a positive depth, the server will compute the set of commits which are no deeper than the desired depth. The set -of commits start at the client's wants. +of commits starts at the client's wants. The server writes 'shallow' lines for each commit whose parents will not be sent as a result. The server writes diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 5a537268e275e4..65c89e7b3eb017 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -186,7 +186,7 @@ current branch integrates with) obviously do not work, as there is no points at the directory that is the real repository. [[def_grafts]]grafts:: - Grafts enables two otherwise different lines of development to be joined + Grafts enable two otherwise different lines of development to be joined together by recording fake ancestry information for commits. This way you can make Git pretend the set of <> a <> has is different from what was recorded when the commit was diff --git a/Documentation/howto/coordinate-embargoed-releases.txt b/Documentation/howto/coordinate-embargoed-releases.txt index e653775bab18dd..b9cb95e82f0eca 100644 --- a/Documentation/howto/coordinate-embargoed-releases.txt +++ b/Documentation/howto/coordinate-embargoed-releases.txt @@ -145,7 +145,7 @@ Opening a Security Advisory draft The first step is to https://github.com/git/git/security/advisories/new[open an advisory]. Technically, this is not necessary. However, it is the most -convenient way to obtain the CVE number and it give us a private repository +convenient way to obtain the CVE number and it gives us a private repository associated with it that can be used to collaborate on a fix. Notifying the Linux distributions diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt index 0efb1153d27f52..3a866af4a4205d 100644 --- a/Documentation/i18n.txt +++ b/Documentation/i18n.txt @@ -34,7 +34,7 @@ project find it more convenient to use legacy encodings, Git does not forbid it. However, there are a few things to keep in mind. -. 'git commit' and 'git commit-tree' issues +. 'git commit' and 'git commit-tree' issue a warning if the commit log message given to it does not look like a valid UTF-8 string, unless you explicitly say your project uses a legacy encoding. The way to say this is to diff --git a/Documentation/technical/api-simple-ipc.txt b/Documentation/technical/api-simple-ipc.txt index d88b1ef206efb6..b4259098680ea6 100644 --- a/Documentation/technical/api-simple-ipc.txt +++ b/Documentation/technical/api-simple-ipc.txt @@ -2,7 +2,7 @@ Simple-IPC API ============== The Simple-IPC API is a collection of `ipc_` prefixed library routines -and a basic communication protocol that allow an IPC-client process to +and a basic communication protocol that allows an IPC-client process to send an application-specific IPC-request message to an IPC-server process and receive an application-specific IPC-response message. diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt index d7d066d876a1e0..84637f96e77cce 100644 --- a/Documentation/technical/reftable.txt +++ b/Documentation/technical/reftable.txt @@ -46,7 +46,7 @@ search lookup, and range scans. Storage in the file is organized into variable sized blocks. Prefix compression is used within a single block to reduce disk space. Block -size and alignment is tunable by the writer. +size and alignment are tunable by the writer. Performance ^^^^^^^^^^^ @@ -288,7 +288,7 @@ The 2-byte `restart_count` stores the number of entries in the `restart_count` to binary search between restarts before starting a linear scan. -Exactly `restart_count` 3-byte `restart_offset` values precedes the +Exactly `restart_count` 3-byte `restart_offset` values precede the `restart_count`. Offsets are relative to the start of the block and refer to the first byte of any `ref_record` whose name has not been prefix compressed. Entries in the `restart_offset` list must be sorted, From 7f7e6bbe06719aa4c6276d5ddf230ba8d6a4d57a Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:10 +0000 Subject: [PATCH 08/25] documentation: employ consistent verb tense for a list Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/push.txt | 2 +- Documentation/config/receive.txt | 2 +- Documentation/git-rev-parse.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/config/push.txt b/Documentation/config/push.txt index 43338b65e843dd..dbaf930f01bbe4 100644 --- a/Documentation/config/push.txt +++ b/Documentation/config/push.txt @@ -35,7 +35,7 @@ push.default:: * `tracking` - This is a deprecated synonym for `upstream`. -* `simple` - pushes the current branch with the same name on the remote. +* `simple` - push the current branch with the same name on the remote. + If you are working on a centralized workflow (pushing to the same repository you pull from, which is typically `origin`), then you need to configure an upstream diff --git a/Documentation/config/receive.txt b/Documentation/config/receive.txt index ae526cbf5841c3..c77e55b1cdd217 100644 --- a/Documentation/config/receive.txt +++ b/Documentation/config/receive.txt @@ -14,7 +14,7 @@ receive.autogc:: receive.certNonceSeed:: By setting this variable to a string, `git receive-pack` - will accept a `git push --signed` and verifies it by using + will accept a `git push --signed` and verify it by using a "nonce" protected by HMAC using this string as a secret key. diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 2294e9a519a8d2..7b3ce3012e370d 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -156,7 +156,7 @@ for another option. are not refs (i.e. branch or tag names; or more explicitly disambiguating "heads/master" form, when you want to name the "master" branch when there is an - unfortunately named tag "master"), and show them as full + unfortunately named tag "master"), and shows them as full refnames (e.g. "refs/heads/master"). Options for Objects From 5676b04a44935752314483182114069ecabe230a Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:11 +0000 Subject: [PATCH 09/25] documentation: fix verb tense Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/advice.txt | 2 +- Documentation/config/clone.txt | 2 +- Documentation/config/column.txt | 2 +- Documentation/git-clean.txt | 2 +- Documentation/git-help.txt | 6 +++--- Documentation/git-whatchanged.txt | 2 +- Documentation/gitcli.txt | 4 ++-- Documentation/gitformat-chunk.txt | 2 +- Documentation/gitformat-pack.txt | 6 +++--- Documentation/gitsubmodules.txt | 4 ++-- Documentation/gitweb.conf.txt | 2 +- Documentation/gitweb.txt | 4 ++-- Documentation/technical/reftable.txt | 2 +- 13 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index f524af4e899b94..c8e38a0e5cde31 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt @@ -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 diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt index a16b1b6fa343ab..d037b57f729e5e 100644 --- a/Documentation/config/clone.txt +++ b/Documentation/config/clone.txt @@ -4,7 +4,7 @@ clone.defaultRemoteName:: option to linkgit:git-clone[1]. clone.rejectShallow:: - Reject to clone a repository if it is a shallow one; this can be overridden by + 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:: diff --git a/Documentation/config/column.txt b/Documentation/config/column.txt index 76aa2f29dc2108..9f30322362dc8e 100644 --- a/Documentation/config/column.txt +++ b/Documentation/config/column.txt @@ -43,7 +43,7 @@ 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:: diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 5e1a3d5148c5eb..69331e3f05a13e 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -103,7 +103,7 @@ filter by pattern:: This shows the files and directories to be deleted and issues an "Input ignore patterns>>" prompt. You can input space-separated patterns to exclude files and directories from deletion. - E.g. "*.c *.h" will excludes files end with ".c" and ".h" from + E.g. "*.c *.h" will exclude files ending with ".c" and ".h" from deletion. When you are satisfied with the filtered result, press ENTER (empty) back to the main menu. diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 7cb4b4bda18912..ee18a2b7432be3 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -48,7 +48,7 @@ OPTIONS ------- -a:: --all:: - Prints all the available commands on the standard output. + Print all the available commands on the standard output. --no-external-commands:: When used with `--all`, exclude the listing of external "git-*" @@ -69,10 +69,10 @@ OPTIONS -g:: --guides:: - Prints a list of the Git concept guides on the standard output. + Print a list of the Git concept guides on the standard output. --user-interfaces:: - Prints a list of the repository, command and file interfaces + Print a list of the repository, command and file interfaces documentation on the standard output. + In-repository file interfaces such as `.git/info/exclude` are diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index 5cbb31f33e3d76..ee8c1aa0ca42a5 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -18,7 +18,7 @@ Shows commit logs and diff output each commit introduces. New users are encouraged to use linkgit:git-log[1] instead. The `whatchanged` command is essentially the same as linkgit:git-log[1] -but defaults to show the raw format diff output and to skip merges. +but defaults to showing the raw format diff output and skipping merges. The command is primarily kept for historical reasons; fingers of many people who learned Git long before `git log` was invented by diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 1819a5a1859c54..f0986881bacddc 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -23,7 +23,7 @@ arguments. Here are the rules: A subcommand may take dashed options (which may take their own arguments, e.g. "--max-parents 2") and arguments. You SHOULD give dashed options first and then arguments. Some commands may - accept dashed options after you have already gave non-option + accept dashed options after you have already given non-option arguments (which may make the command ambiguous), but you should not rely on it (because eventually we may find a way to fix these ambiguity by enforcing the "options then args" rule). @@ -42,7 +42,7 @@ arguments. Here are the rules: `git diff HEAD --` to ask for the latter. * Without disambiguating `--`, Git makes a reasonable guess, but errors - out and asking you to disambiguate when ambiguous. E.g. if you have a + out and asks you to disambiguate when ambiguous. E.g. if you have a file called HEAD in your work tree, `git diff HEAD` is ambiguous, and you have to say either `git diff HEAD --` or `git diff -- HEAD` to disambiguate. diff --git a/Documentation/gitformat-chunk.txt b/Documentation/gitformat-chunk.txt index 76ea678398a3f2..3315df6201dc96 100644 --- a/Documentation/gitformat-chunk.txt +++ b/Documentation/gitformat-chunk.txt @@ -67,7 +67,7 @@ caller is responsible for opening the `hashfile` and writing header information so the file format is identifiable before the chunk-based format begins. -Then, call `add_chunk()` for each chunk that is intended for write. This +Then, call `add_chunk()` for each chunk that is intended for writing. This populates the `chunkfile` with information about the order and size of each chunk to write. Provide a `chunk_write_fn` function pointer to perform the write of the chunk data upon request. diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt index fb3f8fcf56ba00..992f9d7d37aff5 100644 --- a/Documentation/gitformat-pack.txt +++ b/Documentation/gitformat-pack.txt @@ -117,7 +117,7 @@ the delta data is a sequence of instructions to reconstruct the object from the base object. If the base object is deltified, it must be converted to canonical form first. Each instruction appends more and more data to the target object until it's complete. There are two -supported instructions so far: one for copy a byte range from the +supported instructions so far: one for copying a byte range from the source object and one for inserting new data embedded in the instruction itself. @@ -137,7 +137,7 @@ copy. Offset and size are in little-endian order. All offset and size bytes are optional. This is to reduce the instruction size when encoding small offsets or sizes. The first seven -bits in the first octet determines which of the next seven octets is +bits in the first octet determine which of the next seven octets is present. If bit zero is set, offset1 is present. If bit one is set offset2 is present and so on. @@ -163,7 +163,7 @@ converted to 0x10000. This is the instruction to construct target object without the base object. The following data is appended to the target object. The first -seven bits of the first octet determines the size of data in +seven bits of the first octet determine the size of data in bytes. The size must be non-zero. ==== Reserved instruction diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt index 941858a6ecce88..13678ead045adc 100644 --- a/Documentation/gitsubmodules.txt +++ b/Documentation/gitsubmodules.txt @@ -78,7 +78,7 @@ Submodule operations can be configured using the following mechanisms * The command line for those commands that support taking submodules as part of their pathspecs. Most commands have a boolean flag - `--recurse-submodules` which specify whether to recurse into submodules. + `--recurse-submodules` which specifies whether to recurse into submodules. Examples are `grep` and `checkout`. Some commands take enums, such as `fetch` and `push`, where you can specify how submodules are affected. @@ -274,7 +274,7 @@ will not be checked out by default; you can instruct `clone` to recurse into submodules. The `init` and `update` subcommands of `git submodule` will maintain submodules checked out and at an appropriate revision in your working tree. Alternatively you can set `submodule.recurse` to have -`checkout` recursing into submodules (note that `submodule.recurse` also +`checkout` recurse into submodules (note that `submodule.recurse` also affects other Git commands, see linkgit:git-config[1] for a complete list). diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt index 34b1d6e224356c..b078fef6f5c6ff 100644 --- a/Documentation/gitweb.conf.txt +++ b/Documentation/gitweb.conf.txt @@ -53,7 +53,7 @@ following order: `/etc/gitweb-common.conf`), * either per-instance configuration file (defaults to 'gitweb_config.perl' - in the same directory as the installed gitweb), or if it does not exists + in the same directory as the installed gitweb), or if it does not exist then fallback system-wide configuration file (defaults to `/etc/gitweb.conf`). Values obtained in later configuration files override values obtained earlier diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt index bb9cbad7f3feaa..41ce55e266a198 100644 --- a/Documentation/gitweb.txt +++ b/Documentation/gitweb.txt @@ -8,7 +8,7 @@ gitweb - Git web interface (web frontend to Git repositories) SYNOPSIS -------- To get started with gitweb, run linkgit:git-instaweb[1] from a Git repository. -This would configure and start your web server, and run web browser pointing to +This will configure and start your web server, and run a web browser pointing to gitweb. @@ -24,7 +24,7 @@ Gitweb provides a web interface to Git repositories. Its features include: * Viewing the blame/annotation details of any file (if enabled). * Generating RSS and Atom feeds of commits, for any branch. The feeds are auto-discoverable in modern web browsers. -* Viewing everything that was changed in a revision, and step through +* Viewing everything that was changed in a revision, and stepping through revisions one at a time, viewing the history of the repository. * Finding commits whose commit messages match a given search term. diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt index 84637f96e77cce..6def498efd5548 100644 --- a/Documentation/technical/reftable.txt +++ b/Documentation/technical/reftable.txt @@ -247,7 +247,7 @@ uint32( hash_id ) .... The header is identical to `version_number=1`, with the 4-byte hash ID -("sha1" for SHA1 and "s256" for SHA-256) append to the header. +("sha1" for SHA1 and "s256" for SHA-256) appended to the header. For maximum backward compatibility, it is recommended to use version 1 when writing SHA1 reftables. From af181e4dbd130cafc90a8d452dc76aaf8efabb14 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:12 +0000 Subject: [PATCH 10/25] documentation: fix adjective vs. noun Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/commit.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt index 2c95573930bedf..bcb46cf630e489 100644 --- a/Documentation/config/commit.txt +++ b/Documentation/config/commit.txt @@ -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]. From 401a4e257e6be731f7dd230b399800a1d79415d0 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:13 +0000 Subject: [PATCH 11/25] documentation: fix verb vs. noun Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/imap.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/config/imap.txt b/Documentation/config/imap.txt index fa0dccc3d83491..3d28f7264374e6 100644 --- a/Documentation/config/imap.txt +++ b/Documentation/config/imap.txt @@ -4,7 +4,7 @@ imap.folder:: "[Gmail]/Drafts". Required. imap.tunnel:: - Command used to setup a tunnel to the IMAP server through which + Command used to set up a tunnel to the IMAP server through which commands will be piped instead of using a direct network connection to the server. Required when imap.host is not set. From 6cc668c0abd65415a461c6dddfefffaaeb1d5adc Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:14 +0000 Subject: [PATCH 12/25] documentation: fix singular vs. plural Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/ToolsForGit.txt | 2 +- Documentation/config/advice.txt | 2 +- Documentation/config/column.txt | 2 +- Documentation/config/diff.txt | 2 +- Documentation/config/fetch.txt | 2 +- Documentation/config/mailinfo.txt | 2 +- Documentation/config/rerere.txt | 2 +- Documentation/config/user.txt | 2 +- Documentation/config/versionsort.txt | 4 ++-- Documentation/diff-generate-patch.txt | 2 +- Documentation/git-am.txt | 2 +- Documentation/git-merge-tree.txt | 6 +++--- Documentation/git-repack.txt | 2 +- Documentation/git-replace.txt | 2 +- Documentation/git-send-pack.txt | 4 ++-- Documentation/git-show-branch.txt | 2 +- Documentation/git-show.txt | 2 +- Documentation/git-update-index.txt | 6 +++--- Documentation/git-whatchanged.txt | 2 +- Documentation/gitcli.txt | 2 +- Documentation/gitdiffcore.txt | 2 +- Documentation/giteveryday.txt | 2 +- Documentation/githooks.txt | 4 ++-- Documentation/gitsubmodules.txt | 2 +- Documentation/mergetools/vimdiff.txt | 2 +- Documentation/technical/api-index-skel.txt | 2 +- Documentation/technical/racy-git.txt | 2 +- Documentation/technical/repository-version.txt | 2 +- Documentation/urls-remotes.txt | 2 +- 29 files changed, 36 insertions(+), 36 deletions(-) diff --git a/Documentation/ToolsForGit.txt b/Documentation/ToolsForGit.txt index 5d01e8191aa73e..209eaad31ea63e 100644 --- a/Documentation/ToolsForGit.txt +++ b/Documentation/ToolsForGit.txt @@ -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. diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index c8e38a0e5cde31..c5cde1c24eebed 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt @@ -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 diff --git a/Documentation/config/column.txt b/Documentation/config/column.txt index 9f30322362dc8e..01e4198429ed46 100644 --- a/Documentation/config/column.txt +++ b/Documentation/config/column.txt @@ -51,5 +51,5 @@ column.status:: 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. diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt index 9391c77e552eba..bd5ae0c3378adb 100644 --- a/Documentation/config/diff.txt +++ b/Documentation/config/diff.txt @@ -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 diff --git a/Documentation/config/fetch.txt b/Documentation/config/fetch.txt index c1a7cdd6bf4242..aea5b97477b64e 100644 --- a/Documentation/config/fetch.txt +++ b/Documentation/config/fetch.txt @@ -53,7 +53,7 @@ fetch.pruneTags:: fetch.output:: Control how ref update status is printed. Valid values are `full` and `compact`. Default value is `full`. See the - OUTPUT section in linkgit:git-fetch[1] for detail. + OUTPUT section in linkgit:git-fetch[1] for details. fetch.negotiationAlgorithm:: Control how information about the commits in the local repository diff --git a/Documentation/config/mailinfo.txt b/Documentation/config/mailinfo.txt index 3854d4ae37cd77..ec3a5d81f7255a 100644 --- a/Documentation/config/mailinfo.txt +++ b/Documentation/config/mailinfo.txt @@ -1,6 +1,6 @@ mailinfo.scissors:: If true, makes linkgit:git-mailinfo[1] (and therefore linkgit:git-am[1]) act by default as if the --scissors option - was provided on the command-line. When active, this features + was provided on the command-line. When active, this feature removes everything from the message body before a scissors line (i.e. consisting mainly of ">8", "8<" and "-"). diff --git a/Documentation/config/rerere.txt b/Documentation/config/rerere.txt index 40abdf6a6b5d88..3a78b5ebb1dc02 100644 --- a/Documentation/config/rerere.txt +++ b/Documentation/config/rerere.txt @@ -1,7 +1,7 @@ rerere.autoUpdate:: When set to true, `git-rerere` updates the index with the resulting contents after it cleanly resolves conflicts using - previously recorded resolution. Defaults to false. + previously recorded resolutions. Defaults to false. rerere.enabled:: Activate recording of resolved conflicts, so that identical diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt index 958e62464a547f..2bbc8e929f09ef 100644 --- a/Documentation/config/user.txt +++ b/Documentation/config/user.txt @@ -5,7 +5,7 @@ author.email:: committer.name:: committer.email:: The `user.name` and `user.email` variables determine what ends - up in the `author` and `committer` field of commit + up in the `author` and `committer` fields of commit objects. If you need the `author` or `committer` to be different, the `author.name`, `author.email`, `committer.name` or diff --git a/Documentation/config/versionsort.txt b/Documentation/config/versionsort.txt index 6c7cc054fad250..0d66617f59fc56 100644 --- a/Documentation/config/versionsort.txt +++ b/Documentation/config/versionsort.txt @@ -24,9 +24,9 @@ among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and are listed first, followed by "v4.8", then "v4.8-ckX" and finally "v4.8-bfsX". + -If more than one suffixes match the same tagname, then that tagname will +If more than one suffix matches the same tagname, then that tagname will be sorted according to the suffix which starts at the earliest position in -the tagname. If more than one different matching suffixes start at +the tagname. If more than one different matching suffix starts at that earliest position, then that tagname will be sorted according to the longest of those suffixes. The sorting order between different suffixes is undefined if they are diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 49ad31fca2ab79..65e0b1646e1001 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -142,7 +142,7 @@ or like this (when the `--cc` option is used): + The `mode ,..` line appears only if at least one of the is different from the rest. Extended headers with -information about detected contents movement (renames and +information about detected content movement (renames and copying detection) are designed to work with diff of two and are not used by combined diff format. diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 900be198b14e93..51c267151592e3 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -22,7 +22,7 @@ SYNOPSIS DESCRIPTION ----------- -Splits mail messages in a mailbox into commit log message, +Splits mail messages in a mailbox into commit log messages, authorship information and patches, and applies them to the current branch. You could think of it as a reverse operation of linkgit:git-format-patch[1] run on a branch with a straight diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt index ffc4fbf7e89a89..9f951c7fe34ba5 100644 --- a/Documentation/git-merge-tree.txt +++ b/Documentation/git-merge-tree.txt @@ -24,7 +24,7 @@ this documentation describes modern `--write-tree` mode. Performs a merge, but does not make any new commits and does not read from or write to either the working tree or index. -The performed merge will use the same feature as the "real" +The performed merge will use the same features as the "real" linkgit:git-merge[1], including: * three way content merges of individual files @@ -253,7 +253,7 @@ Do NOT attempt to guess or make the user guess the conflict types from the <> list. The information there is insufficient to do so. For example: Rename/rename(1to2) conflicts (both sides renamed the same file differently) will result in three different -file having higher order stages (but each only has one higher order +files having higher order stages (but each only has one higher order stage), with no way (short of the <> section) to determine which three files are related. File/directory conflicts also result in a file with exactly one higher order stage. @@ -263,7 +263,7 @@ a file with exactly one higher order stage. In all cases, the <> section has the necessary info, though it is not designed to be machine parseable. -Do NOT assume that each paths from <>, and +Do NOT assume that each path from <>, and the logical conflicts in the <> have a one-to-one mapping, nor that there is a one-to-many mapping, nor a many-to-one mapping. Many-to-many mappings exist, meaning that each diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index cbc0ece61e37c0..882ec056a3c9a1 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -207,7 +207,7 @@ When `--unpacked` is specified, loose objects are implicitly included in this "roll-up", without respect to their reachability. This is subject to change in the future. This option (implying a drastically different repack mode) is not guaranteed to work with all other combinations of -option to `git repack`. +options to `git repack`. + When writing a multi-pack bitmap, `git repack` selects the largest resulting pack as the preferred pack for object selection by the MIDX (see diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt index f271d758c38230..fdd2e0f08833d3 100644 --- a/Documentation/git-replace.txt +++ b/Documentation/git-replace.txt @@ -111,7 +111,7 @@ OPTIONS FORMATS ------- -The following format are available: +The following formats are available: * 'short': diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index e76c262d7f9710..9c1ed757b9d951 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -115,7 +115,7 @@ both on the local side and on the remote side are updated. When one or more '' are specified explicitly (whether on the command line or via `--stdin`), it can be either a -single pattern, or a pair of such pattern separated by a colon +single pattern, or a pair of such patterns separated by a colon ":" (this means that a ref name cannot have a colon in it). A single pattern '' is just shorthand for ':'. @@ -130,7 +130,7 @@ name. See linkgit:git-rev-parse[1]. - It is an error if does not match exactly one of the local refs. - - It is an error if matches more than one remote refs. + - It is an error if matches more than one remote ref. - If does not match any remote ref, either diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 58cf6210cde2d3..080b5246a4ed12 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -154,7 +154,7 @@ $ git show-branch master fixes mhf ! [mhf] Allow "+remote:local" refspec to cause --force when fetching. --- + [mhf] Allow "+remote:local" refspec to cause --force when fetching. - + [mhf~1] Use git-octopus when pulling more than one heads. + + [mhf~1] Use git-octopus when pulling more than one head. + [fixes] Introduce "reset type" flag to "git reset" + [mhf~2] "git fetch --force". + [mhf~3] Use .git/remote/origin, not .git/branches/origin. diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index 03c06345186f24..5eb67439affbef 100644 --- a/Documentation/git-show.txt +++ b/Documentation/git-show.txt @@ -61,7 +61,7 @@ EXAMPLES -------- `git show v1.0.0`:: - Shows the tag `v1.0.0`, along with the object the tags + Shows the tag `v1.0.0`, along with the object the tag points at. `git show v1.0.0^{tree}`:: diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 1271486ae9ccfe..7f0c950a5fd572 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -49,7 +49,7 @@ OPTIONS --remove:: If a specified file is in the index but is missing then it's removed. - Default behavior is to ignore removed file. + Default behavior is to ignore removed files. --refresh:: Looks at the current index and checks to see if merges or @@ -108,7 +108,7 @@ you will need to handle the situation manually. without regard to the "assume unchanged" setting. --[no-]skip-worktree:: - When one of these flags is specified, the object name recorded + When one of these flags is specified, the object names recorded for the paths are not updated. Instead, these options set and unset the "skip-worktree" bit for the paths. See section "Skip-worktree bit" below for more information. @@ -119,7 +119,7 @@ you will need to handle the situation manually. the `--remove` option was specified. --[no-]fsmonitor-valid:: - When one of these flags is specified, the object name recorded + When one of these flags is specified, the object names recorded for the paths are not updated. Instead, these options set and unset the "fsmonitor valid" bit for the paths. See section "File System Monitor" below for more information. diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index ee8c1aa0ca42a5..fc2dc5a3b1dd98 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -3,7 +3,7 @@ git-whatchanged(1) NAME ---- -git-whatchanged - Show logs with difference each commit introduces +git-whatchanged - Show logs with differences each commit introduces SYNOPSIS diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index f0986881bacddc..71ffe5556aed0a 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -26,7 +26,7 @@ arguments. Here are the rules: accept dashed options after you have already given non-option arguments (which may make the command ambiguous), but you should not rely on it (because eventually we may find a way to fix - these ambiguity by enforcing the "options then args" rule). + these ambiguities by enforcing the "options then args" rule). * Revisions come first and then paths. E.g. in `git diff v1.0 v2.0 arch/x86 include/asm-x86`, diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 5681ba3f3302c1..411ce8635987f3 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -230,7 +230,7 @@ like these: * -B/60 (the same as above, since diffcore-break defaults to 50%). -Note that earlier implementation left a broken pair as a separate +Note that earlier implementation left a broken pair as separate creation and deletion patches. This was an unnecessary hack and the latest implementation always merges all the broken pairs back into modifications, but the resulting patch output is diff --git a/Documentation/giteveryday.txt b/Documentation/giteveryday.txt index faba2ef0881c52..12b62b91256240 100644 --- a/Documentation/giteveryday.txt +++ b/Documentation/giteveryday.txt @@ -14,7 +14,7 @@ DESCRIPTION ----------- Git users can broadly be grouped into four categories for the purposes of -describing here a small set of useful command for everyday Git. +describing here a small set of useful commands for everyday Git. * <> commands are essential for anybody who makes a commit, even for somebody who works alone. diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 34e2c656de3030..e62ad343eda66e 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -80,7 +80,7 @@ If it exits with non-zero status, then the working tree will not be committed after applying the patch. It can be used to inspect the current working tree and refuse to -make a commit if it does not pass certain test. +make a commit if it does not pass certain tests. The default 'pre-applypatch' hook, when enabled, runs the 'pre-commit' hook, if the latter is enabled. @@ -379,7 +379,7 @@ following example for the protocol, the letter 'S' stands for S: ... ... S: flush-pkt - # Receive result from the hook. + # Receive results from the hook. # OK, run this command successfully. H: PKT-LINE(ok ) # NO, I reject it. diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt index 13678ead045adc..8400d591da0e8a 100644 --- a/Documentation/gitsubmodules.txt +++ b/Documentation/gitsubmodules.txt @@ -192,7 +192,7 @@ For example: [submodule "baz"] url = https://example.org/baz -In the above config only the submodule 'bar' and 'baz' are active, +In the above config only the submodules 'bar' and 'baz' are active, 'bar' due to (1) and 'baz' due to (3). 'foo' is inactive because (1) takes precedence over (3) diff --git a/Documentation/mergetools/vimdiff.txt b/Documentation/mergetools/vimdiff.txt index c36c5479392b22..d1a4c468e6354e 100644 --- a/Documentation/mergetools/vimdiff.txt +++ b/Documentation/mergetools/vimdiff.txt @@ -162,7 +162,7 @@ information as the first tab, with a different layout. | REMOTE | | --------------------------------------------- .... -Note how in the third tab definition we need to use parenthesis to make `,` +Note how in the third tab definition we need to use parentheses to make `,` have precedence over `/`. -- diff --git a/Documentation/technical/api-index-skel.txt b/Documentation/technical/api-index-skel.txt index eda8c195c19629..7780a76b080e4b 100644 --- a/Documentation/technical/api-index-skel.txt +++ b/Documentation/technical/api-index-skel.txt @@ -1,7 +1,7 @@ Git API Documents ================= -Git has grown a set of internal API over time. This collection +Git has grown a set of internal APIs over time. This collection documents them. //////////////////////////////////////////////////////////////// diff --git a/Documentation/technical/racy-git.txt b/Documentation/technical/racy-git.txt index 02ae508d227c04..59bea66c0fc6ef 100644 --- a/Documentation/technical/racy-git.txt +++ b/Documentation/technical/racy-git.txt @@ -190,7 +190,7 @@ In a large project where raciness avoidance cost really matters, however, the initial computation of all object names in the index takes more than one second, and the index file is written out after all that happens. Therefore the timestamp of the -index file will be more than one seconds later than the +index file will be more than one second later than the youngest file in the working tree. This means that in these cases there actually will not be any racily clean entry in the resulting index. diff --git a/Documentation/technical/repository-version.txt b/Documentation/technical/repository-version.txt index 8ef664b0b9537a..045a76756fcf47 100644 --- a/Documentation/technical/repository-version.txt +++ b/Documentation/technical/repository-version.txt @@ -96,7 +96,7 @@ The value of this key is the name of the promisor remote. ==== `worktreeConfig` If set, by default "git config" reads from both "config" and -"config.worktree" file from GIT_DIR in that order. In +"config.worktree" files from GIT_DIR in that order. In multiple working directory mode, "config" file is shared while "config.worktree" is per-working directory (i.e., it's in GIT_COMMON_DIR/worktrees//config.worktree) diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt index 3504afbf2e9652..bf17012241536c 100644 --- a/Documentation/urls-remotes.txt +++ b/Documentation/urls-remotes.txt @@ -48,7 +48,7 @@ provide a refspec on the command line. This file should have the following format: ------------ - URL: one of the above URL format + URL: one of the above URL formats Push: Pull: From 03b3431e6a36d9a529f49d938168043b463ca24b Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:15 +0000 Subject: [PATCH 13/25] documentation: whitespace is already generally plural Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/apply.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/config/apply.txt b/Documentation/config/apply.txt index 3f9ff19db6b865..f9908e210a838d 100644 --- a/Documentation/config/apply.txt +++ b/Documentation/config/apply.txt @@ -7,5 +7,5 @@ apply.ignoreWhitespace:: 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]. From 3771d002571f6fc796ff3f54e9d5b875826e62ed Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:16 +0000 Subject: [PATCH 14/25] documentation: fix choice of article Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config.txt | 2 +- Documentation/diff-generate-patch.txt | 2 +- Documentation/howto/maintain-git.txt | 2 +- Documentation/pretty-options.txt | 2 +- Documentation/technical/bitmap-format.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 9273c7f1c6564f..99affec5a01bbe 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -103,7 +103,7 @@ was found. See below for examples. Conditional includes ~~~~~~~~~~~~~~~~~~~~ -You can conditionally include a config file from another by setting a +You can conditionally include a config file from another by setting an `includeIf..path` variable to the name of the file to be included. diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 65e0b1646e1001..4b307cb51bb1a7 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -156,7 +156,7 @@ format, `/dev/null` is used to signal created or deleted files. + However, if the --combined-all-paths option is provided, instead of a -two-line from-file/to-file you get a N+1 line from-file/to-file header, +two-line from-file/to-file you get an N+1 line from-file/to-file header, where N is the number of parents in the merge commit: --- a/file diff --git a/Documentation/howto/maintain-git.txt b/Documentation/howto/maintain-git.txt index 29c473e5e04568..013014bbef67ac 100644 --- a/Documentation/howto/maintain-git.txt +++ b/Documentation/howto/maintain-git.txt @@ -411,7 +411,7 @@ Preparing a "merge-fix" A merge of two topics may not textually conflict but still have conflict at the semantic level. A classic example is for one topic -to rename an variable and all its uses, while another topic adds a +to rename a variable and all its uses, while another topic adds a new use of the variable under its old name. When these two topics are merged together, the reference to the variable newly added by the latter topic will still use the old name in the result. diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 335395b727fe43..15c6f2705d4b28 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -73,7 +73,7 @@ environment overrides). See linkgit:git-config[1] for more details. With an optional '' argument, use the ref to find the notes to display. The ref can specify the full refname when it begins with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise -`refs/notes/` is prefixed to form a full name of the ref. +`refs/notes/` is prefixed to form the full name of the ref. + Multiple --notes options can be combined to control which notes are being displayed. Examples: "--notes=foo" will show only notes from diff --git a/Documentation/technical/bitmap-format.txt b/Documentation/technical/bitmap-format.txt index 687c58cebcc01d..f761828f10685c 100644 --- a/Documentation/technical/bitmap-format.txt +++ b/Documentation/technical/bitmap-format.txt @@ -126,7 +126,7 @@ Each entry contains the following: ** {empty} 1-byte XOR-offset: :: The xor offset used to compress this bitmap. For an entry - in position `x`, a XOR offset of `y` means that the actual + in position `x`, an XOR offset of `y` means that the actual bitmap representing this commit is composed by XORing the bitmap for this entry with the bitmap in entry `x-y` (i.e. the bitmap `y` entries before this one). From 0a4f051f9318c3dd9db69c4bebecdc6d160a5fc6 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:17 +0000 Subject: [PATCH 15/25] documentation: add missing article Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/ReviewingGuidelines.txt | 2 +- Documentation/config/advice.txt | 2 +- Documentation/config/commit.txt | 2 +- Documentation/config/fsck.txt | 2 +- Documentation/config/gc.txt | 2 +- Documentation/config/gui.txt | 2 +- Documentation/config/man.txt | 2 +- Documentation/config/notes.txt | 2 +- Documentation/config/sendemail.txt | 2 +- Documentation/config/stash.txt | 8 ++++---- Documentation/diff-generate-patch.txt | 10 +++++----- Documentation/fsck-msgids.txt | 2 +- Documentation/git-am.txt | 4 ++-- Documentation/git-apply.txt | 4 ++-- Documentation/git-blame.txt | 4 ++-- Documentation/git-check-ref-format.txt | 2 +- Documentation/git-checkout-index.txt | 6 +++--- Documentation/git-count-objects.txt | 2 +- Documentation/git-daemon.txt | 2 +- Documentation/git-diff-tree.txt | 2 +- Documentation/git-difftool.txt | 2 +- Documentation/git-fsck.txt | 2 +- Documentation/git-help.txt | 2 +- Documentation/git-http-push.txt | 4 ++-- Documentation/git-init.txt | 4 ++-- Documentation/git-mailsplit.txt | 2 +- Documentation/git-merge-base.txt | 2 +- Documentation/git-merge-tree.txt | 2 +- Documentation/git-mktag.txt | 2 +- Documentation/git-prune.txt | 2 +- Documentation/git-push.txt | 2 +- Documentation/git-read-tree.txt | 4 ++-- Documentation/git-receive-pack.txt | 4 ++-- Documentation/git-remote-ext.txt | 10 +++++----- Documentation/git-remote-fd.txt | 4 ++-- Documentation/git-replace.txt | 2 +- Documentation/git-rev-parse.txt | 2 +- Documentation/git-send-pack.txt | 2 +- Documentation/git-sh-setup.txt | 2 +- Documentation/git-show-branch.txt | 2 +- Documentation/git-stripspace.txt | 2 +- Documentation/git-update-index.txt | 8 ++++---- Documentation/git-update-ref.txt | 2 +- Documentation/git-update-server-info.txt | 2 +- Documentation/git-verify-pack.txt | 6 +++--- Documentation/git-whatchanged.txt | 2 +- Documentation/gitcli.txt | 2 +- Documentation/gitdiffcore.txt | 6 +++--- Documentation/gitformat-pack.txt | 8 ++++---- Documentation/githooks.txt | 2 +- Documentation/gitprotocol-capabilities.txt | 2 +- Documentation/gitweb.txt | 8 ++++---- Documentation/pretty-options.txt | 2 +- Documentation/pull-fetch-param.txt | 4 ++-- Documentation/rev-list-options.txt | 4 ++-- Documentation/technical/bitmap-format.txt | 2 +- Documentation/technical/partial-clone.txt | 2 +- 57 files changed, 93 insertions(+), 93 deletions(-) diff --git a/Documentation/ReviewingGuidelines.txt b/Documentation/ReviewingGuidelines.txt index 0e323d54779a7c..3e98c8a6af041e 100644 --- a/Documentation/ReviewingGuidelines.txt +++ b/Documentation/ReviewingGuidelines.txt @@ -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/xmqqilm1yp3m.fsf@gitster.g/[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]; diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index c5cde1c24eebed..2737381a11a1b4 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt @@ -5,7 +5,7 @@ advice.*:: + -- ambiguousFetchRefspec:: - Advice shown when fetch refspec for multiple remotes maps 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:: diff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt index bcb46cf630e489..62f0d92fda51de 100644 --- a/Documentation/config/commit.txt +++ b/Documentation/config/commit.txt @@ -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). diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt index 0687e86ba10071..57114161063047 100644 --- a/Documentation/config/fsck.txt +++ b/Documentation/config/fsck.txt @@ -36,7 +36,7 @@ Setting an unknown `fsck.` value will cause fsck to die, but doing the same for `receive.fsck.` and `fetch.fsck.` 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 ``. diff --git a/Documentation/config/gc.txt b/Documentation/config/gc.txt index 17e2a8cc1767d7..31f1fff53c4b3b 100644 --- a/Documentation/config/gc.txt +++ b/Documentation/config/gc.txt @@ -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:: diff --git a/Documentation/config/gui.txt b/Documentation/config/gui.txt index 0c087fd8c9313e..171be774d243fd 100644 --- a/Documentation/config/gui.txt +++ b/Documentation/config/gui.txt @@ -24,7 +24,7 @@ gui.matchTrackingBranch:: not. Default: "false". gui.newBranchTemplate:: - Is used as suggested name when creating new branches using the + Is used as a suggested name when creating new branches using the linkgit:git-gui[1]. gui.pruneDuringFetch:: diff --git a/Documentation/config/man.txt b/Documentation/config/man.txt index a727d987a8d48c..5a0f82cc2327a2 100644 --- a/Documentation/config/man.txt +++ b/Documentation/config/man.txt @@ -5,7 +5,7 @@ man.viewer:: man..cmd:: Specify the command to invoke the specified man viewer. The specified command is evaluated in shell with the man page - passed as argument. (See linkgit:git-help[1].) + passed as an argument. (See linkgit:git-help[1].) man..path:: Override the path for the given tool that may be used to diff --git a/Documentation/config/notes.txt b/Documentation/config/notes.txt index c7c4811734b5c9..43db8e808d7ab7 100644 --- a/Documentation/config/notes.txt +++ b/Documentation/config/notes.txt @@ -1,7 +1,7 @@ notes.mergeStrategy:: Which merge strategy to choose by default when resolving notes conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or - `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" + `cat_sort_uniq`. Defaults to `manual`. See the "NOTES MERGE STRATEGIES" section of linkgit:git-notes[1] for more information on each strategy. + This setting can be overridden by passing the `--strategy` option to diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.txt index 792e68a4456972..7fc770ee9e69d7 100644 --- a/Documentation/config/sendemail.txt +++ b/Documentation/config/sendemail.txt @@ -91,7 +91,7 @@ sendemail.smtpBatchSize:: See also the `--batch-size` option of linkgit:git-send-email[1]. sendemail.smtpReloginDelay:: - Seconds to wait before reconnecting to smtp server. + Seconds to wait before reconnecting to the smtp server. See also the `--relogin-delay` option of linkgit:git-send-email[1]. sendemail.forbidSendmailVariables:: diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt index b9f609ed76b7f3..ec1edaeba68aa3 100644 --- a/Documentation/config/stash.txt +++ b/Documentation/config/stash.txt @@ -1,14 +1,14 @@ stash.showIncludeUntracked:: If this is set to true, the `git stash show` command will show the untracked files of a stash entry. Defaults to false. See - description of 'show' command in linkgit:git-stash[1]. + the description of the 'show' command in linkgit:git-stash[1]. stash.showPatch:: If this is set to true, the `git stash show` command without an option will show the stash entry in patch form. Defaults to false. - See description of 'show' command in linkgit:git-stash[1]. + See the description of the 'show' command in linkgit:git-stash[1]. stash.showStat:: If this is set to true, the `git stash show` command without an - option will show diffstat of the stash entry. Defaults to true. - See description of 'show' command in linkgit:git-stash[1]. + option will show a diffstat of the stash entry. Defaults to true. + See the description of the 'show' command in linkgit:git-stash[1]. diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 4b307cb51bb1a7..cf1958ca632df3 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -25,9 +25,9 @@ The `a/` and `b/` filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion, `/dev/null` is _not_ used in place of the `a/` or `b/` filenames. + -When rename/copy is involved, `file1` and `file2` show the +When a rename/copy is involved, `file1` and `file2` show the name of the source file of the rename/copy and the name of -the file that rename/copy produces, respectively. +the file that the rename/copy produces, respectively. 2. It is followed by one or more extended header lines: @@ -89,7 +89,7 @@ produce a 'combined diff' when showing a merge. This is the default format when showing merges with linkgit:git-diff[1] or linkgit:git-show[1]. Note also that you can give suitable `--diff-merges` option to any of these commands to force generation of -diffs in specific format. +diffs in a specific format. A "combined diff" format looks like this: @@ -143,7 +143,7 @@ or like this (when the `--cc` option is used): The `mode ,..` line appears only if at least one of the is different from the rest. Extended headers with information about detected content movement (renames and -copying detection) are designed to work with diff of two +copying detection) are designed to work with the diff of two and are not used by combined diff format. 3. It is followed by a two-line from-file/to-file header: @@ -151,7 +151,7 @@ copying detection) are designed to work with diff of two --- a/file +++ b/file + -Similar to two-line header for traditional 'unified' diff +Similar to the two-line header for the traditional 'unified' diff format, `/dev/null` is used to signal created or deleted files. + diff --git a/Documentation/fsck-msgids.txt b/Documentation/fsck-msgids.txt index 8505c244bcf5bd..f643585a34e761 100644 --- a/Documentation/fsck-msgids.txt +++ b/Documentation/fsck-msgids.txt @@ -132,7 +132,7 @@ (ERROR) Missing space before date in an author/committer line. `missingSpaceBeforeEmail`:: - (ERROR) Missing space before the email in author/committer line. + (ERROR) Missing space before the email in an author/committer line. `missingTag`:: (ERROR) Unexpected end after `type` line in a tag object. diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 51c267151592e3..00a5ec206d63ff 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -94,7 +94,7 @@ OPTIONS Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). The proposed commit log message taken from the e-mail is re-coded into UTF-8 encoding (configuration variable - `i18n.commitEncoding` can be used to specify project's + `i18n.commitEncoding` can be used to specify the project's preferred encoding if it is not UTF-8). + This was optional in prior versions of git, but now it is the @@ -192,7 +192,7 @@ include::rerere-options.txt[] --abort:: Restore the original branch and abort the patching operation. - Revert contents of files involved in the am operation to their + Revert the contents of files involved in the am operation to their pre-am state. --quit:: diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index b6e7510d068a2d..95bde308709a07 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -140,7 +140,7 @@ linkgit:git-config[1]). applying a diff generated with `--unified=0`. To bypass these checks use `--unidiff-zero`. + -Note, for the reasons stated above usage of context-free patches is +Note, for the reasons stated above the usage of context-free patches is discouraged. --apply:: @@ -257,7 +257,7 @@ the `--unsafe-paths` option to override this safety check. This option has no effect when `--index` or `--cached` is in use. --allow-empty:: - Don't return error for patches containing no diff. This includes + Don't return an error for patches containing no diff. This includes empty patches and patches with commit text only. CONFIGURATION diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index a927c7c9f33b1b..6f39147c0513b6 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -77,7 +77,7 @@ include::blame-options.txt[] -e:: --show-email:: - Show the author email instead of author name (Default: off). + Show the author email instead of the author name (Default: off). This can also be controlled via the `blame.showEmail` config option. @@ -100,7 +100,7 @@ When neither `--porcelain` nor `--incremental` option is specified, `git blame` will output annotation for each line with: - abbreviated object name for the commit the line came from; -- author ident (by default author name and date, unless `-s` or `-e` +- author ident (by default the author name and date, unless `-s` or `-e` is specified); and - line number diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index ee6a4144fbef1a..1d6e08e0119c7b 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -85,7 +85,7 @@ The rule `git check-ref-format --branch $name` implements may be stricter than what `git check-ref-format refs/heads/$name` says (e.g. a dash may appear at the beginning of a ref component, but it is explicitly forbidden at the beginning of a branch name). -When run with `--branch` option in a repository, the input is first +When run with the `--branch` option in a repository, the input is first expanded for the ``previous checkout syntax'' `@{-n}`. For example, `@{-1}` is a way to refer the last thing that was checked out using "git switch" or "git checkout" operation. diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index d1738f4330850b..4e2527612e0726 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -53,7 +53,7 @@ OPTIONS --stage=|all:: Instead of checking out unmerged entries, copy out the - files from named stage. must be between 1 and 3. + files from the named stage. must be between 1 and 3. Note: --stage=all automatically implies --temp. --temp:: @@ -66,8 +66,8 @@ OPTIONS set. --stdin:: - Instead of taking list of paths from the command line, - read list of paths from the standard input. Paths are + Instead of taking a list of paths from the command line, + read the list of paths from the standard input. Paths are separated by LF (i.e. one path per line) by default. -z:: diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt index b28cc3a510a1c8..97f9f1261010f5 100644 --- a/Documentation/git-count-objects.txt +++ b/Documentation/git-count-objects.txt @@ -33,7 +33,7 @@ size-pack: disk space consumed by the packs, in KiB (unless -H is specified) prune-packable: the number of loose objects that are also present in the packs. These objects could be pruned using `git prune-packed`. + -garbage: the number of files in object database that are neither valid loose +garbage: the number of files in the object database that are neither valid loose objects nor valid packs + size-garbage: disk space consumed by garbage files, in KiB (unless -H is diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 236df516c7313d..e064f91c9e3589 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -138,7 +138,7 @@ otherwise `stderr`. --user-path:: --user-path=:: Allow {tilde}user notation to be used in requests. When - specified with no parameter, requests to + specified with no parameter, a request to git://host/{tilde}alice/foo is taken as a request to access 'foo' repository in the home directory of user `alice`. If `--user-path=path` is specified, the same request is diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 1e34f80daa9145..c2772a566a3ee1 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -78,7 +78,7 @@ commits (but not trees). By default, 'git diff-tree --stdin' shows differences, either in machine-readable form (without `-p`) or in patch form (with `-p`). This output can be suppressed. It is - only useful with `-v` flag. + only useful with the `-v` flag. -v:: This flag causes 'git diff-tree --stdin' to also show diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt index 179e5ae216231d..50cb080085e770 100644 --- a/Documentation/git-difftool.txt +++ b/Documentation/git-difftool.txt @@ -36,7 +36,7 @@ OPTIONS --rotate-to=:: Start showing the diff for the given path, - the paths before it will move to end and output. + the paths before it will move to the end and output. --skip-to=:: Start showing the diff for the given path, skipping all diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index e4980d286151a7..5b82e4605c2e91 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt @@ -24,7 +24,7 @@ OPTIONS An object to treat as the head of an unreachability trace. + If no objects are given, 'git fsck' defaults to using the -index file, all SHA-1 references in `refs` namespace, and all reflogs +index file, all SHA-1 references in the `refs` namespace, and all reflogs (unless --no-reflogs is given) as heads. --unreachable:: diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index ee18a2b7432be3..22dfd7808515c0 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -85,7 +85,7 @@ pseudo-configuration such as the file-based `.git/hooks/*` interface described in linkgit:githooks[5]. --developer-interfaces:: - Print list of file formats, protocols and other developer + Print a list of file formats, protocols and other developer interfaces documentation on the standard output. -i:: diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt index 8b4a5791c8cf03..c0c841b9fddf47 100644 --- a/Documentation/git-http-push.txt +++ b/Documentation/git-http-push.txt @@ -13,12 +13,12 @@ SYNOPSIS DESCRIPTION ----------- -Sends missing objects to remote repository, and updates the +Sends missing objects to the remote repository, and updates the remote branch. *NOTE*: This command is temporarily disabled if your libcurl is older than 7.16, as the combination has been reported -not to work and sometimes corrupts repository. +not to work and sometimes corrupts the repository. OPTIONS ------- diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 138dc4a3bfe962..3c3c1e730c3695 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -66,10 +66,10 @@ DIRECTORY" section below.) Instead of initializing the repository as a directory to either `$GIT_DIR` or `./.git/`, create a text file there containing the path to the actual -repository. This file acts as filesystem-agnostic Git symbolic link to the +repository. This file acts as a filesystem-agnostic Git symbolic link to the repository. + -If this is reinitialization, the repository will be moved to the specified path. +If this is a reinitialization, the repository will be moved to the specified path. -b :: --initial-branch=:: diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt index e3b2a88c4b75f1..3f0a6662c81efb 100644 --- a/Documentation/git-mailsplit.txt +++ b/Documentation/git-mailsplit.txt @@ -34,7 +34,7 @@ OPTIONS -b:: If any file doesn't begin with a From line, assume it is a - single mail message instead of signaling error. + single mail message instead of signaling an error. -d:: Instead of the default 4 digits with leading zeros, diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index b01ba3d3565096..463764b9c1ec12 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -18,7 +18,7 @@ SYNOPSIS DESCRIPTION ----------- -'git merge-base' finds best common ancestor(s) between two commits to use +'git merge-base' finds the best common ancestor(s) between two commits to use in a three-way merge. One common ancestor is 'better' than another common ancestor if the latter is an ancestor of the former. A common ancestor that does not have any better common ancestor is a 'best common diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt index 9f951c7fe34ba5..b50acace3bc367 100644 --- a/Documentation/git-merge-tree.txt +++ b/Documentation/git-merge-tree.txt @@ -19,7 +19,7 @@ DESCRIPTION This command has a modern `--write-tree` mode and a deprecated `--trivial-merge` mode. With the exception of the <> section at the end, the rest of -this documentation describes modern `--write-tree` mode. +this documentation describes the modern `--write-tree` mode. Performs a merge, but does not make any new commits and does not read from or write to either the working tree or index. diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index 7a01496234300f..006d759962ac61 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt @@ -56,7 +56,7 @@ has a very simple fixed format: four lines of tagger followed by some 'optional' free-form message (some tags created -by older Git may not have `tagger` line). The message, when it +by older Git may not have a `tagger` line). The message, when it exists, is separated by a blank line from the header. The message part may contain a signature that Git itself doesn't care about, but that can be verified with gpg. diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt index 03552dd86fc412..9a45571b901b15 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt @@ -18,7 +18,7 @@ NOTE: In most cases, users should run 'git gc', which calls 'git prune'. See the section "NOTES", below. This runs 'git fsck --unreachable' using all the refs -available in `refs/`, optionally with additional set of +available in `refs/`, optionally with an additional set of objects specified on the command line, and prunes all unpacked objects unreachable from any of these head objects from the object database. In addition, it diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 5b4edaf4a8dfcc..c12caedbb1868f 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -48,7 +48,7 @@ local one. OPTIONS[[OPTIONS]] ------------------ :: - The "remote" repository that is destination of a push + The "remote" repository that is the destination of a push operation. This parameter can be either a URL (see the section <> below) or the name of a remote (see the section <> below). diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 32065318532451..1c48c289963063 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -26,14 +26,14 @@ flag. When used with `-m`, the `-u` flag causes it to also update the files in the work tree with the result of the merge. Only trivial merges are done by 'git read-tree' itself. Only conflicting paths -will be in unmerged state when 'git read-tree' returns. +will be in an unmerged state when 'git read-tree' returns. OPTIONS ------- -m:: Perform a merge, not just a read. The command will refuse to run if your index file has unmerged entries, - indicating that you have not finished previous merge you + indicating that you have not finished a previous merge you started. --reset:: diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt index 65ff518ccff49e..20aca92073d8c9 100644 --- a/Documentation/git-receive-pack.txt +++ b/Documentation/git-receive-pack.txt @@ -18,10 +18,10 @@ information fed from the remote end. This command is usually not invoked directly by the end user. The UI for the protocol is on the 'git send-pack' side, and the -program pair is meant to be used to push updates to remote +program pair is meant to be used to push updates to a remote repository. For pull operations, see linkgit:git-fetch-pack[1]. -The command allows for creation and fast-forwarding of sha1 refs +The command allows for the creation and fast-forwarding of sha1 refs (heads/tags) on the remote end (strictly speaking, it is the local end 'git-receive-pack' runs, but to the user who is sitting at the send-pack end, it is updating the remote. Confused?) diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt index 17d84f23c99e3b..b33ee3c9e863b6 100644 --- a/Documentation/git-remote-ext.txt +++ b/Documentation/git-remote-ext.txt @@ -44,15 +44,15 @@ The following sequences have a special meaning: This argument will not be passed to ''. Instead, it will cause the helper to start by sending git:// service requests to the remote side with the service field set to an appropriate value and - the repository field set to rest of the argument. Default is not to send + the repository field set to the rest of the argument. Default is not to send such a request. + -This is useful if remote side is git:// server accessed over +This is useful if the remote side is git:// server accessed over some tunnel. '%V' (must be first characters in argument):: This argument will not be passed to ''. Instead it sets - the vhost field in the git:// service request (to rest of the argument). + the vhost field in the git:// service request (to the rest of the argument). Default is not to send vhost in such request (if sent). ENVIRONMENT VARIABLES @@ -82,12 +82,12 @@ begins with `ext::`. Examples: "ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'":: Like host.example:foo/repo, but use /home/foo/.ssh/somekey as - keypair and user as user on remote side. This avoids the need to + keypair and user as the user on the remote side. This avoids the need to edit .ssh/config. "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo":: Represents repository with path /somerepo accessible over - git protocol at abstract namespace address /git-server. + git protocol at the abstract namespace address /git-server. "ext::git-server-alias foo %G/repo":: Represents a repository with path /repo accessed using the diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt index 0451ceb8a26dfc..6ed71bd0b75af4 100644 --- a/Documentation/git-remote-fd.txt +++ b/Documentation/git-remote-fd.txt @@ -25,7 +25,7 @@ It is assumed that any handshaking procedures have already been completed (such as sending service request for git://) before this helper is started. can be any string. It is ignored. It is meant for providing -information to user in the URL in case that URL is displayed in some +information to the user in the URL in case that URL is displayed in some context. ENVIRONMENT VARIABLES @@ -45,7 +45,7 @@ EXAMPLES `git push fd::7,8 master (as URL)`:: Push master, using file descriptor #7 to read data from git-receive-pack and file descriptor #8 to write data to - same service. + the same service. `git push fd::7,8/bar master`:: Same as above. diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt index fdd2e0f08833d3..4f257126e33cc7 100644 --- a/Documentation/git-replace.txt +++ b/Documentation/git-replace.txt @@ -35,7 +35,7 @@ Replacement references will be used by default by all Git commands except those doing reachability traversal (prune, pack transfer and fsck). -It is possible to disable use of replacement references for any +It is possible to disable the use of replacement references for any command using the `--no-replace-objects` option just after 'git'. For example if commit 'foo' has been replaced by commit 'bar': diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 7b3ce3012e370d..f42fb93870568f 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- -Many Git porcelainish commands take mixture of flags +Many Git porcelainish commands take a mixture of flags (i.e. parameters that begin with a dash '-') and parameters meant for the underlying 'git rev-list' command they use internally and flags and parameters for the other commands they use diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index 9c1ed757b9d951..b9e73f2e77b1cc 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -106,7 +106,7 @@ SPECIFYING THE REFS There are three ways to specify which refs to update on the remote end. -With `--all` flag, all refs that exist locally are transferred to +With the `--all` flag, all refs that exist locally are transferred to the remote side. You cannot specify any '' if you use this flag. diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index 8632612c31d078..bdaf6e5fc4fa79 100644 --- a/Documentation/git-sh-setup.txt +++ b/Documentation/git-sh-setup.txt @@ -22,7 +22,7 @@ The 'git sh-setup' scriptlet is designed to be sourced (using the normal Git directories and a few helper shell functions. Before sourcing it, your script should set up a few variables; -`USAGE` (and `LONG_USAGE`, if any) is used to define message +`USAGE` (and `LONG_USAGE`, if any) is used to define the message given by `usage()` shell function. `SUBDIRECTORY_OK` can be set if the script can run from a subdirectory of the working tree (some commands do not). diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 080b5246a4ed12..ddf24aeb87d89a 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -137,7 +137,7 @@ their commit message. The branch head that is pointed at by $GIT_DIR/HEAD is prefixed with an asterisk `*` character while other heads are prefixed with a `!` character. -Following these N lines, one-line log for each commit is +Following these N lines, a one-line log for each commit is displayed, indented N places. If a commit is on the I-th branch, the I-th indentation character shows a `+` sign; otherwise it shows a space. Merge commits are denoted by diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt index 3dc630da4b708a..6b92cc7de78ab3 100644 --- a/Documentation/git-stripspace.txt +++ b/Documentation/git-stripspace.txt @@ -37,7 +37,7 @@ OPTIONS ------- -s:: --strip-comments:: - Skip and remove all lines starting with comment character (default '#'). + Skip and remove all lines starting with a comment character (default '#'). -c:: --comment-lines:: diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 7f0c950a5fd572..7ac2e37c0ac7cd 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -95,7 +95,7 @@ OPTIONS the index. If you want to change the working tree file, you need to unset the bit to tell Git. This is sometimes helpful when working with a big project on a - filesystem that has very slow lstat(2) system call + filesystem that has a very slow lstat(2) system call (e.g. cifs). + Git will fail (gracefully) in case it needs to modify this file @@ -151,12 +151,12 @@ you will need to handle the situation manually. automatically removed with warning messages. --stdin:: - Instead of taking list of paths from the command line, - read list of paths from the standard input. Paths are + Instead of taking a list of paths from the command line, + read a list of paths from the standard input. Paths are separated by LF (i.e. one path per line) by default. --verbose:: - Report what is being added and removed from index. + Report what is being added and removed from the index. --index-version :: Write the resulting index out in the named on-disk format version. diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 48b6683071e65b..0561808cca04a6 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -118,7 +118,7 @@ verify:: is zero or missing, the ref must not exist. option:: - Modify behavior of the next command naming a . + Modify the behavior of the next command naming a . The only valid option is `no-deref` to avoid dereferencing a symbolic ref. diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt index 17e429dbd09560..ff32986d4c538e 100644 --- a/Documentation/git-update-server-info.txt +++ b/Documentation/git-update-server-info.txt @@ -29,7 +29,7 @@ OUTPUT ------ Currently the command updates the following files. Please see -linkgit:gitrepository-layout[5] for description of +linkgit:gitrepository-layout[5] for a description of what they are for: * objects/info/packs diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt index b8720dce8abc34..d7e886918aa7af 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt @@ -15,7 +15,7 @@ SYNOPSIS DESCRIPTION ----------- Reads given idx file for packed Git archive created with the -'git pack-objects' command and verifies idx file and the +'git pack-objects' command and verifies the idx file and the corresponding pack file. OPTIONS @@ -25,13 +25,13 @@ OPTIONS -v:: --verbose:: - After verifying the pack, show list of objects contained + After verifying the pack, show the list of objects contained in the pack and a histogram of delta chain length. -s:: --stat-only:: Do not verify the pack contents; only show the histogram of delta - chain length. With `--verbose`, list of objects is also shown. + chain length. With `--verbose`, the list of objects is also shown. \--:: Do not interpret any more arguments as options. diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index fc2dc5a3b1dd98..8e55e0bb1ec8a6 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -22,7 +22,7 @@ but defaults to showing the raw format diff output and skipping merges. The command is primarily kept for historical reasons; fingers of many people who learned Git long before `git log` was invented by -reading Linux kernel mailing list are trained to type it. +reading the Linux kernel mailing list are trained to type it. Examples diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 71ffe5556aed0a..e5fac943227a23 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -37,7 +37,7 @@ arguments. Here are the rules: they can be disambiguated by placing `--` between them. E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work tree. Please show changes between the version I staged in the index - and what I have in the work tree for that file", not "show difference + and what I have in the work tree for that file", not "show the difference between the HEAD commit and the work tree as a whole". You can say `git diff HEAD --` to ask for the latter. diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 411ce8635987f3..bc65f91310d597 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -213,7 +213,7 @@ from the original, and does not count insertion. If you removed only 10 lines from a 100-line document, even if you added 910 new lines to make a new 1000-line document, you did not do a complete rewrite. diffcore-break breaks such a case in order to -help diffcore-rename to consider such filepairs as candidate of +help diffcore-rename to consider such filepairs as a candidate of rename/copy detection, but if filepairs broken that way were not matched with other filepairs to create rename/copy, then this transformation merges them back into the original @@ -235,8 +235,8 @@ creation and deletion patches. This was an unnecessary hack and the latest implementation always merges all the broken pairs back into modifications, but the resulting patch output is formatted differently for easier review in case of such -a complete rewrite by showing the entire contents of old version -prefixed with '-', followed by the entire contents of new +a complete rewrite by showing the entire contents of the old version +prefixed with '-', followed by the entire contents of the new version prefixed with '+'. diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt index 992f9d7d37aff5..8fac3fcf9b41ce 100644 --- a/Documentation/gitformat-pack.txt +++ b/Documentation/gitformat-pack.txt @@ -48,7 +48,7 @@ Similarly, in SHA-256 repositories, these values are computed using SHA-256. Observation: we cannot have more than 4G versions ;-) and more than 4G objects in a pack. - - The header is followed by number of object entries, each of + - The header is followed by a number of object entries, each of which looks like this: (undeltified representation) @@ -62,7 +62,7 @@ Similarly, in SHA-256 repositories, these values are computed using SHA-256. is an OBJ_OFS_DELTA object compressed delta data - Observation: length of each object is encoded in a variable + Observation: the length of each object is encoded in a variable length format and is not constrained to 32-bit or anything. - The trailer records a pack checksum of all of the above. @@ -161,7 +161,7 @@ converted to 0x10000. | 0xxxxxxx | data | +----------+============+ -This is the instruction to construct target object without the base +This is the instruction to construct the target object without the base object. The following data is appended to the target object. The first seven bits of the first octet determine the size of data in bytes. The size must be non-zero. @@ -294,7 +294,7 @@ Pack file entry: <+ - The same trailer as a v1 pack file: - A copy of the pack checksum at the end of + A copy of the pack checksum at the end of the corresponding packfile. Index checksum of all of the above. diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index e62ad343eda66e..883982e7a05162 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -157,7 +157,7 @@ If the exit status is non-zero, `git commit` will abort. The purpose of the hook is to edit the message file in place, and it is not suppressed by the `--no-verify` option. A non-zero exit means a failure of the hook and aborts the commit. It should not -be used as replacement for pre-commit hook. +be used as a replacement for the pre-commit hook. The sample `prepare-commit-msg` hook that comes with Git removes the help message found in the commented portion of the commit template. diff --git a/Documentation/gitprotocol-capabilities.txt b/Documentation/gitprotocol-capabilities.txt index 388846d92e918e..d6c6effc2151ff 100644 --- a/Documentation/gitprotocol-capabilities.txt +++ b/Documentation/gitprotocol-capabilities.txt @@ -88,7 +88,7 @@ interleaved with S-R-Q. multi_ack_detailed ------------------ -This is an extension of multi_ack that permits client to better +This is an extension of multi_ack that permits the client to better understand the server's in-memory state. See linkgit:gitprotocol-pack[5], section "Packfile Negotiation" for more information. diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt index 41ce55e266a198..1030e9667ea8c2 100644 --- a/Documentation/gitweb.txt +++ b/Documentation/gitweb.txt @@ -41,9 +41,9 @@ for details. Repositories ~~~~~~~~~~~~ Gitweb can show information from one or more Git repositories. These -repositories have to be all on local filesystem, and have to share common +repositories have to be all on local filesystem, and have to share a common repository root, i.e. be all under a single parent repository (but see also -"Advanced web server setup" section, "Webserver configuration with multiple +the "Advanced web server setup" section, "Webserver configuration with multiple projects' root" subsection). ----------------------------------------------------------------------- @@ -51,7 +51,7 @@ our $projectroot = '/path/to/parent/directory'; ----------------------------------------------------------------------- The default value for `$projectroot` is `/pub/git`. You can change it during -building gitweb via `GITWEB_PROJECTROOT` build configuration variable. +building gitweb via the `GITWEB_PROJECTROOT` build configuration variable. By default all Git repositories under `$projectroot` are visible and available to gitweb. The list of projects is generated by default by scanning the @@ -66,7 +66,7 @@ found at "$projectroot/$repo". Projects list file format ~~~~~~~~~~~~~~~~~~~~~~~~~ -Instead of having gitweb find repositories by scanning filesystem +Instead of having gitweb find repositories by scanning the filesystem starting from $projectroot, you can provide a pre-generated list of visible projects by setting `$projects_list` to point to a plain text file with a list of projects (with some additional info). diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 15c6f2705d4b28..23888cd612c9fb 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -48,7 +48,7 @@ people using 80-column terminals. --expand-tabs:: --no-expand-tabs:: Perform a tab expansion (replace each tab with enough spaces - to fill to the next display column that is multiple of '') + to fill to the next display column that is a multiple of '') in the log message before showing it in the output. `--expand-tabs` is a short-hand for `--expand-tabs=8`, and `--no-expand-tabs` is a short-hand for `--expand-tabs=0`, diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index 74143ef0d247ee..c718f7946f065d 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -80,7 +80,7 @@ configuration which'll amend these rules, and nothing like a + As with pushing with linkgit:git-push[1], all of the rules described above about what's not allowed as an update can be overridden by -adding an optional leading `+` to a refspec (or using `--force` +adding an optional leading `+` to a refspec (or using the `--force` command line option). The only exception to this is that no amount of forcing will make the `refs/heads/*` namespace accept a non-commit object. @@ -88,7 +88,7 @@ object. [NOTE] When the remote branch you want to fetch is known to be rewound and rebased regularly, it is expected that -its new tip will not be descendant of its previous tip +its new tip will not be a descendant of its previous tip (as stored in your remote-tracking branch the last time you fetched). You would want to use the `+` sign to indicate non-fast-forward updates diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 66d71d1b957683..2bf239ff0309aa 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -56,7 +56,7 @@ endif::git-rev-list[] error to use this option unless `--walk-reflogs` is in use. --grep=:: - Limit the commits output to ones with log message that + Limit the commits output to ones with a log message that matches the specified pattern (regular expression). With more than one `--grep=`, commits whose message matches any of the given patterns are chosen (but see @@ -72,7 +72,7 @@ endif::git-rev-list[] instead of ones that match at least one. --invert-grep:: - Limit the commits output to ones with log message that do not + Limit the commits output to ones with a log message that do not match the pattern specified with `--grep=`. -i:: diff --git a/Documentation/technical/bitmap-format.txt b/Documentation/technical/bitmap-format.txt index f761828f10685c..f5d200939b0560 100644 --- a/Documentation/technical/bitmap-format.txt +++ b/Documentation/technical/bitmap-format.txt @@ -239,7 +239,7 @@ bitmaps. For a `.bitmap` containing `nr_entries` reachability bitmaps, the table contains a list of `nr_entries` triplets -(sorted in the ascending order of `commit_pos`). The content of i'th +(sorted in the ascending order of `commit_pos`). The content of the i'th triplet is - * {empty} diff --git a/Documentation/technical/partial-clone.txt b/Documentation/technical/partial-clone.txt index 29876ca582ae79..cd948b00722cba 100644 --- a/Documentation/technical/partial-clone.txt +++ b/Documentation/technical/partial-clone.txt @@ -256,7 +256,7 @@ remote in a specific order. - Dynamic object fetching currently uses the existing pack protocol V0 which means that each object is requested via fetch-pack. The server will send a full set of info/refs when the connection is established. - If there are large number of refs, this may incur significant overhead. + If there are a large number of refs, this may incur significant overhead. Future Work From f22fdf33aff48def873eed9f5d30abf9fc0d8700 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:18 +0000 Subject: [PATCH 16/25] documentation: remove unnecessary hyphens Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/ReviewingGuidelines.txt | 2 +- Documentation/git-check-attr.txt | 2 +- Documentation/git-merge-base.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/ReviewingGuidelines.txt b/Documentation/ReviewingGuidelines.txt index 3e98c8a6af041e..515d470d23c1f1 100644 --- a/Documentation/ReviewingGuidelines.txt +++ b/Documentation/ReviewingGuidelines.txt @@ -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: :: diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt index 6e4f3aaf34c957..7fea245ed222c8 100644 --- a/Documentation/git-check-attr.txt +++ b/Documentation/git-check-attr.txt @@ -29,7 +29,7 @@ OPTIONS --stdin:: Read pathnames from the standard input, one per line, - instead of from the command-line. + instead of from the command line. -z:: The output format is modified to be machine-parsable. diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index 463764b9c1ec12..5cdcb5663cd3db 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -130,7 +130,7 @@ When the history involves criss-cross merges, there can be more than one ---2---o---o---B .... -both '1' and '2' are merge-bases of A and B. Neither one is better than +both '1' and '2' are merge bases of A and B. Neither one is better than the other (both are 'best' merge bases). When the `--all` option is not given, it is unspecified which best one is output. From 0cac690e1ac5e26ecf2dba0c53ac3824425446b5 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:19 +0000 Subject: [PATCH 17/25] documentation: add missing hyphens Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config.txt | 2 +- Documentation/config/pack.txt | 2 +- Documentation/config/status.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 99affec5a01bbe..b1dba1ae8531f2 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -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. diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.txt index 6308f21e03d5f7..f50df9dbce8989 100644 --- a/Documentation/config/pack.txt +++ b/Documentation/config/pack.txt @@ -87,7 +87,7 @@ pack.indexVersion:: larger than 2 GB. + If you have an old Git that does not understand the version 2 `*.idx` file, -cloning or fetching over a non native protocol (e.g. "http") +cloning or fetching over a non-native protocol (e.g. "http") that will copy both `*.pack` file and corresponding `*.idx` file from the other side may give you a repository that cannot be accessed with your older version of Git. If the `*.pack` file is smaller than 2 GB, however, diff --git a/Documentation/config/status.txt b/Documentation/config/status.txt index f0336938cbce25..2ff8237f8fc458 100644 --- a/Documentation/config/status.txt +++ b/Documentation/config/status.txt @@ -62,7 +62,7 @@ of linkgit:git-status[1] and linkgit:git-commit[1]. status.submoduleSummary:: Defaults to false. - If this is set to a non zero number or true (identical to -1 or an + If this is set to a non-zero number or true (identical to -1 or an unlimited number), the submodule summary will be enabled and a summary of commits for modified submodules will be shown (see --summary-limit option of linkgit:git-submodule[1]). Please note From 9a9fd289cc81a3bb69eb2b4e11db27509e0eb515 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:20 +0000 Subject: [PATCH 18/25] documentation: use clearer prepositions Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/SubmittingPatches | 2 +- Documentation/config/branch.txt | 2 +- Documentation/config/i18n.txt | 2 +- Documentation/diff-generate-patch.txt | 4 ++-- Documentation/git-am.txt | 2 +- Documentation/git-diff-files.txt | 2 +- Documentation/git-fsmonitor--daemon.txt | 2 +- Documentation/git-hook.txt | 2 +- Documentation/git-merge-base.txt | 4 ++-- Documentation/git-mergetool.txt | 2 +- Documentation/git-request-pull.txt | 2 +- Documentation/git-rev-parse.txt | 2 +- Documentation/git-show-branch.txt | 4 ++-- Documentation/git-update-index.txt | 2 +- 14 files changed, 17 insertions(+), 17 deletions(-) diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 973d7a81d4492d..0e2d3fbb9ccd6c 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -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 diff --git a/Documentation/config/branch.txt b/Documentation/config/branch.txt index 3bec6daf71ab9f..432b9cd2c0e667 100644 --- a/Documentation/config/branch.txt +++ b/Documentation/config/branch.txt @@ -99,5 +99,5 @@ for details). branch..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. diff --git a/Documentation/config/i18n.txt b/Documentation/config/i18n.txt index cc256217317c66..6e72fdb45bd0cd 100644 --- a/Documentation/config/i18n.txt +++ b/Documentation/config/i18n.txt @@ -2,7 +2,7 @@ i18n.commitEncoding:: Character encoding the commit messages are stored in; Git itself does not care per se, but this information is necessary e.g. when importing commits from emails or in the gitk graphical history - browser (and possibly at other places in the future or in other + browser (and possibly in other places in the future or in other porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. i18n.logOutputEncoding:: diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index cf1958ca632df3..988e33de70b5c4 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -17,7 +17,7 @@ You can customize the creation of patch text via the What the -p option produces is slightly different from the traditional diff format: -1. It is preceded with a "git diff" header that looks like this: +1. It is preceded by a "git diff" header that looks like this: diff --git a/file1 b/file2 + @@ -123,7 +123,7 @@ index fabadb8,cc95eb0..4866510 for_each_ref(get_name); ------------ -1. It is preceded with a "git diff" header, that looks like +1. It is preceded by a "git diff" header, that looks like this (when the `-c` option is used): diff --combined file diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 00a5ec206d63ff..2ada047b6aa58c 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -69,7 +69,7 @@ OPTIONS --empty=(stop|drop|keep):: By default, or when the option is set to 'stop', the command errors out on an input e-mail message lacking a patch - and stops into the middle of the current am session. When this + and stops in the middle of the current am session. When this option is set to 'drop', skip such an e-mail message instead. When this option is set to 'keep', create an empty commit, recording the contents of the e-mail message as its log. diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index 591e3801b7b164..18f7f86bef3b14 100644 --- a/Documentation/git-diff-files.txt +++ b/Documentation/git-diff-files.txt @@ -42,7 +42,7 @@ omit diff output for unmerged entries and just show "Unmerged". commit with these flags. -q:: - Remain silent even on nonexistent files + Remain silent even for nonexistent files include::diff-format.txt[] diff --git a/Documentation/git-fsmonitor--daemon.txt b/Documentation/git-fsmonitor--daemon.txt index f50a28b09f9cba..324299bfe9b5aa 100644 --- a/Documentation/git-fsmonitor--daemon.txt +++ b/Documentation/git-fsmonitor--daemon.txt @@ -70,7 +70,7 @@ the change (as happening against the super repo). However, the client will properly ignore these extra events, so performance may be affected but it will not cause an incorrect result. -By default, the fsmonitor daemon refuses to work against network-mounted +By default, the fsmonitor daemon refuses to work with network-mounted repositories; this may be overridden by setting `fsmonitor.allowRemote` to `true`. Note, however, that the fsmonitor daemon is not guaranteed to work correctly with all network-mounted repositories and such use is considered diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt index 3407f3c2c07826..25237330b5cd6e 100644 --- a/Documentation/git-hook.txt +++ b/Documentation/git-hook.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -A command interface to running git hooks (see linkgit:githooks[5]), +A command interface for running git hooks (see linkgit:githooks[5]), for use by other scripted git commands. SUBCOMMANDS diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index 5cdcb5663cd3db..cbc77f72588b5c 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -28,7 +28,7 @@ merge base for a pair of commits. OPERATION MODES --------------- -As the most common special case, specifying only two commits on the +In the most common special case, specifying only two commits on the command line means computing the merge base between the given two commits. More generally, among the two commits to compute the merge base from, @@ -64,7 +64,7 @@ from linkgit:git-show-branch[1] when used with the `--merge-base` option. the two commits, but also takes into account the reflog of to see if the history leading to forked from an earlier incarnation of the branch (see discussion - on this mode below). + of this mode below). OPTIONS ------- diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 800a3cbe6f3bea..7b7b6f8f344e15 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -17,7 +17,7 @@ Use `git mergetool` to run one of several merge utilities to resolve merge conflicts. It is typically run after 'git merge'. If one or more parameters are given, the merge tool program will -be run to resolve differences on each file (skipping those without +be run to resolve differences in each file (skipping those without conflicts). Specifying a directory will include all unresolved files in that path. If no names are specified, 'git mergetool' will run the merge tool program on every file with merge conflicts. diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt index fa5a42670929a9..d274002666ca4b 100644 --- a/Documentation/git-request-pull.txt +++ b/Documentation/git-request-pull.txt @@ -50,7 +50,7 @@ EXAMPLES -------- Imagine that you built your work on your `master` branch on top of -the `v1.0` release, and want it to be integrated to the project. +the `v1.0` release, and want it to be integrated into the project. First you push that change to your public repository for others to see: diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index f42fb93870568f..912fab9f5e00b6 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -383,7 +383,7 @@ Each line of options has this format: dash to separate words in a multi-word argument hint. The remainder of the line, after stripping the spaces, is used -as the help associated to the option. +as the help associated with the option. Blank lines are ignored, and lines that don't match this specification are used as option group headers (start the line with a space to create such diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index ddf24aeb87d89a..4ef0872b4633e3 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -50,7 +50,7 @@ OPTIONS --current:: With this option, the command includes the current - branch to the list of revs to be shown when it is not + branch in the list of revs to be shown when it is not given on the command line. --topo-order:: @@ -197,7 +197,7 @@ $ git show-branch --reflog="10,1 hour ago" --list master shows 10 reflog entries going back from the tip as of 1 hour ago. Without `--list`, the output also shows how these tips are -topologically related with each other. +topologically related to each other. CONFIGURATION ------------- diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 7ac2e37c0ac7cd..e030dd75bede47 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -127,7 +127,7 @@ you will need to handle the situation manually. -g:: --again:: Runs 'git update-index' itself on the paths whose index - entries are different from those from the `HEAD` commit. + entries are different from those of the `HEAD` commit. --unresolve:: Restores the 'unmerged' or 'needs updating' state of a From f4e1851a291f550b16b16f0b265b5b15976b8533 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:21 +0000 Subject: [PATCH 19/25] documentation: fix punctuation Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/format.txt | 2 +- Documentation/config/fsck.txt | 2 +- Documentation/git-fsmonitor--daemon.txt | 2 +- Documentation/git-init.txt | 2 +- Documentation/git-ls-files.txt | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt index 8cf6f00d9365cf..c98412b697efea 100644 --- a/Documentation/config/format.txt +++ b/Documentation/config/format.txt @@ -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]. diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt index 57114161063047..2384c8c94d6d03 100644 --- a/Documentation/config/fsck.txt +++ b/Documentation/config/fsck.txt @@ -62,7 +62,7 @@ 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 diff --git a/Documentation/git-fsmonitor--daemon.txt b/Documentation/git-fsmonitor--daemon.txt index 324299bfe9b5aa..65c7b4641e875a 100644 --- a/Documentation/git-fsmonitor--daemon.txt +++ b/Documentation/git-fsmonitor--daemon.txt @@ -83,7 +83,7 @@ but not on network-mounted filesystems, NTFS, or FAT32. Other filesystems may or may not have the needed support; the fsmonitor daemon is not guaranteed to work with these filesystems and such use is considered experimental. -By default, the socket is created in the `.git` directory, however, if the +By default, the socket is created in the `.git` directory. However, if the `.git` directory is on a network-mounted filesystem, it will instead be created at `$HOME/.git-fsmonitor-*` unless `$HOME` itself is on a network-mounted filesystem in which case you must set the configuration diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 3c3c1e730c3695..6f0d2973bf444a 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -29,7 +29,7 @@ to use instead of `./.git` for the base of the repository. If the object storage directory is specified via the `$GIT_OBJECT_DIRECTORY` environment variable then the sha1 directories -are created underneath - otherwise the default `$GIT_DIR/objects` +are created underneath; otherwise, the default `$GIT_DIR/objects` directory is used. Running 'git init' in an existing repository is safe. It will not diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 60d1cca14960bd..f65a8cd91d4bb4 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -62,7 +62,7 @@ OPTIONS matching an exclude pattern. When showing "other" files (i.e. when used with '-o'), show only those matched by an exclude pattern. Standard ignore rules are not automatically - activated, therefore at least one of the `--exclude*` options + activated; therefore, at least one of the `--exclude*` options is required. -s:: @@ -141,7 +141,7 @@ OPTIONS Show status tags together with filenames. Note that for scripting purposes, linkgit:git-status[1] `--porcelain` and linkgit:git-diff-files[1] `--name-status` are almost always - superior alternatives, and users should look at + superior alternatives; users should look at linkgit:git-status[1] `--short` or linkgit:git-diff[1] `--name-status` for more user-friendly alternatives. + From 2150b6fb473fe965edc5bbdbcf3b264bdfe544db Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:22 +0000 Subject: [PATCH 20/25] documentation: fix capitalization Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/config/checkout.txt | 2 +- Documentation/config/user.txt | 2 +- Documentation/git-diff-tree.txt | 4 ++-- Documentation/git-hook.txt | 2 +- Documentation/git-mergetool--lib.txt | 10 +++++----- Documentation/git-stripspace.txt | 2 +- Documentation/git-update-server-info.txt | 2 +- Documentation/technical/reftable.txt | 2 +- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt index a54faab238a534..a3230229938055 100644 --- a/Documentation/config/checkout.txt +++ b/Documentation/config/checkout.txt @@ -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 diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt index 2bbc8e929f09ef..c1347fa7bcd7bf 100644 --- a/Documentation/config/user.txt +++ b/Documentation/config/user.txt @@ -40,7 +40,7 @@ user.signingKey:: your private ssh key or the public key when ssh-agent is used. Alternatively it can contain a public key prefixed with `key::` directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key - needs to be available via ssh-agent. If not set git will call + needs to be available via ssh-agent. If not set Git will call gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the first key available. For backward compatibility, a raw key which begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index c2772a566a3ee1..22380d5c829616 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -34,10 +34,10 @@ include::diff-options.txt[] matching one of the provided pathspecs. -r:: - recurse into sub-trees + Recurse into sub-trees -t:: - show tree entry itself as well as subtrees. Implies -r. + Show tree entry itself as well as subtrees. Implies -r. --root:: When `--root` is specified the initial commit will be shown as a big diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt index 25237330b5cd6e..f6cc72d2ca9c70 100644 --- a/Documentation/git-hook.txt +++ b/Documentation/git-hook.txt @@ -32,7 +32,7 @@ OPTIONS ------- --to-stdin:: - For "run"; Specify a file which will be streamed into the + For "run"; specify a file which will be streamed into the hook's stdin. The hook will receive the entire file from beginning to EOF. diff --git a/Documentation/git-mergetool--lib.txt b/Documentation/git-mergetool--lib.txt index 3e8f59ac0e46ab..0726b560d43288 100644 --- a/Documentation/git-mergetool--lib.txt +++ b/Documentation/git-mergetool--lib.txt @@ -28,22 +28,22 @@ to define the operation mode for the functions listed below. FUNCTIONS --------- get_merge_tool:: - returns a merge tool. the return code is 1 if we returned a guessed + Returns a merge tool. The return code is 1 if we returned a guessed merge tool, else 0. '$GIT_MERGETOOL_GUI' may be set to 'true' to search for the appropriate guitool. get_merge_tool_cmd:: - returns the custom command for a merge tool. + Returns the custom command for a merge tool. get_merge_tool_path:: - returns the custom path for a merge tool. + Returns the custom path for a merge tool. initialize_merge_tool:: - bring merge tool specific functions into scope so they can be used or + Brings merge tool specific functions into scope so they can be used or overridden. run_merge_tool:: - launches a merge tool given the tool name and a true/false + Launches a merge tool given the tool name and a true/false flag to indicate whether a merge base is present. '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined for use by the merge tool. diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt index 6b92cc7de78ab3..a293327581aa54 100644 --- a/Documentation/git-stripspace.txt +++ b/Documentation/git-stripspace.txt @@ -29,7 +29,7 @@ With no arguments, this will: In the case where the input consists entirely of whitespace characters, no output will be produced. -*NOTE*: This is intended for cleaning metadata, prefer the `--whitespace=fix` +*NOTE*: This is intended for cleaning metadata. Prefer the `--whitespace=fix` mode of linkgit:git-apply[1] for correcting whitespace of patches or files in the repository. diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt index ff32986d4c538e..6bc9b50d89f7aa 100644 --- a/Documentation/git-update-server-info.txt +++ b/Documentation/git-update-server-info.txt @@ -23,7 +23,7 @@ OPTIONS ------- -f:: --force:: - update the info files from scratch. + Update the info files from scratch. OUTPUT ------ diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt index 6def498efd5548..82d919b26157d3 100644 --- a/Documentation/technical/reftable.txt +++ b/Documentation/technical/reftable.txt @@ -175,7 +175,7 @@ log_index* footer .... -in a log-only file the first log block immediately follows the file +In a log-only file the first log block immediately follows the file header, without padding to block alignment. Block size From 42bdb80a084f1405f2e57394146c977ad4f3b75a Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:23 +0000 Subject: [PATCH 21/25] documentation: fix whitespace issues Get rid of extraneous whitespace, replace tab-after-fullstop with space, etc. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/git-blame.txt | 2 +- Documentation/git-check-ignore.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 6f39147c0513b6..5720d04ffe4e74 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -170,7 +170,7 @@ which limits the annotation to the body of the `hello` subroutine. When you are not interested in changes older than version v2.6.18, or changes older than 3 weeks, you can use revision -range specifiers similar to 'git rev-list': +range specifiers similar to 'git rev-list': git blame v2.6.18.. -- foo git blame --since=3.weeks -- foo diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt index 2892799e32f985..3e3b4e344629d9 100644 --- a/Documentation/git-check-ignore.txt +++ b/Documentation/git-check-ignore.txt @@ -50,7 +50,7 @@ linkgit:gitignore[5]. with a NUL character instead of a linefeed character. -n, --non-matching:: - Show given paths which don't match any pattern. This only + Show given paths which don't match any pattern. This only makes sense when `--verbose` is enabled, otherwise it would not be possible to distinguish between paths which match a pattern and those which don't. From 4d542687fcea27c6cce9a79415ad8cb1a817697c Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:24 +0000 Subject: [PATCH 22/25] documentation: add some commas where they are helpful Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/ToolsForGit.txt | 2 +- Documentation/config/clean.txt | 2 +- Documentation/config/color.txt | 2 +- Documentation/config/credential.txt | 2 +- Documentation/config/fastimport.txt | 4 ++-- Documentation/config/fsck.txt | 10 +++++----- Documentation/config/log.txt | 2 +- Documentation/config/merge.txt | 2 +- Documentation/config/mergetool.txt | 10 +++++----- Documentation/config/push.txt | 2 +- Documentation/config/sequencer.txt | 2 +- Documentation/config/splitindex.txt | 6 +++--- Documentation/config/user.txt | 4 ++-- Documentation/config/versionsort.txt | 2 +- Documentation/diff-generate-patch.txt | 4 ++-- Documentation/fetch-options.txt | 2 +- Documentation/git-am.txt | 4 ++-- Documentation/git-apply.txt | 10 +++++----- Documentation/git-check-attr.txt | 4 ++-- Documentation/git-checkout-index.txt | 2 +- Documentation/git-diff-files.txt | 4 ++-- Documentation/git-fast-import.txt | 2 +- Documentation/git-fsmonitor--daemon.txt | 4 ++-- Documentation/git-help.txt | 6 +++--- Documentation/git-http-push.txt | 2 +- Documentation/git-merge-base.txt | 4 ++-- Documentation/git-mergetool.txt | 4 ++-- Documentation/git-mv.txt | 2 +- Documentation/git-name-rev.txt | 2 +- Documentation/git-remote-fd.txt | 4 ++-- Documentation/git-request-pull.txt | 2 +- Documentation/git-show-branch.txt | 4 ++-- Documentation/git-update-index.txt | 2 +- Documentation/gitdiffcore.txt | 4 ++-- Documentation/gitformat-pack.txt | 2 +- Documentation/technical/api-simple-ipc.txt | 4 ++-- Documentation/technical/reftable.txt | 2 +- 37 files changed, 66 insertions(+), 66 deletions(-) diff --git a/Documentation/ToolsForGit.txt b/Documentation/ToolsForGit.txt index 209eaad31ea63e..ae7690b45d08b3 100644 --- a/Documentation/ToolsForGit.txt +++ b/Documentation/ToolsForGit.txt @@ -5,7 +5,7 @@ Tools for developing Git [[summary]] == Summary -This document gathers tips, scripts and configuration files 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. diff --git a/Documentation/config/clean.txt b/Documentation/config/clean.txt index a807c925b9ca8c..f05b9403b5ad90 100644 --- a/Documentation/config/clean.txt +++ b/Documentation/config/clean.txt @@ -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. diff --git a/Documentation/config/color.txt b/Documentation/config/color.txt index 1795b2d16be2f0..2f2275ac6975f2 100644 --- a/Documentation/config/color.txt +++ b/Documentation/config/color.txt @@ -106,7 +106,7 @@ color.grep.:: 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 diff --git a/Documentation/config/credential.txt b/Documentation/config/credential.txt index 075ef8c97503c0..0221c3e620da89 100644 --- a/Documentation/config/credential.txt +++ b/Documentation/config/credential.txt @@ -21,7 +21,7 @@ credential.username:: credential..*:: 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. diff --git a/Documentation/config/fastimport.txt b/Documentation/config/fastimport.txt index c1166e330d55da..903677d7efefa0 100644 --- a/Documentation/config/fastimport.txt +++ b/Documentation/config/fastimport.txt @@ -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. diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt index 2384c8c94d6d03..8e9e508933f894 100644 --- a/Documentation/config/fsck.txt +++ b/Documentation/config/fsck.txt @@ -13,10 +13,10 @@ The rest of the documentation discusses `fsck.*` for brevity, but the same applies for the corresponding `receive.fsck.*` and `fetch.fsck.*`. variables. + -Unlike variables like `color.ui` and `core.editor` the +Unlike variables like `color.ui` and `core.editor`, the `receive.fsck.` and `fetch.fsck.` variables will not fall back on the `fsck.` configuration if they aren't set. To -uniformly configure the same fsck settings in different circumstances +uniformly configure the same fsck settings in different circumstances, all three of them must be set to the same values. + When `fsck.` is set, errors can be switched to warnings and @@ -43,12 +43,12 @@ values of ``. 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 + 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. + @@ -58,7 +58,7 @@ Like `fsck.` 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 +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 diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt index 6e04fbe4f48810..9003a8219143ab 100644 --- a/Documentation/config/log.txt +++ b/Documentation/config/log.txt @@ -9,7 +9,7 @@ log.date:: `--date` option. See linkgit:git-log[1] for details. + If the format is set to "auto:foo" and the pager is in use, format -"foo" will be used for the date format. Otherwise "default" will +"foo" will be used for the date format. Otherwise, "default" will be used. log.decorate:: diff --git a/Documentation/config/merge.txt b/Documentation/config/merge.txt index 99e83dd36e53e6..8851b6cedef980 100644 --- a/Documentation/config/merge.txt +++ b/Documentation/config/merge.txt @@ -7,7 +7,7 @@ merge.conflictStyle:: marker and the original text before the `=======` marker. The "merge" style tends to produce smaller conflict regions than diff3, both because of the exclusion of the original text, and because - when a subset of lines match on the two sides they are just pulled + when a subset of lines match on the two sides, they are just pulled out of the conflict region. Another alternate style, "zdiff3", is similar to diff3 but removes matching lines on the two sides from the conflict region when those matching lines appear near either diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.txt index fe4ba0271b5bc9..294f61efd12fdf 100644 --- a/Documentation/config/mergetool.txt +++ b/Documentation/config/mergetool.txt @@ -22,8 +22,8 @@ mergetool..trustExitCode:: For a custom merge command, specify whether the exit code of the merge command can be used to determine whether the merge was successful. If this is not set to true then the merge target file - timestamp is checked and the merge is assumed to have been successful - if the file has been updated, otherwise the user is prompted to + timestamp is checked, and the merge is assumed to have been successful + if the file has been updated; otherwise, the user is prompted to indicate the success of the merge. mergetool.meld.hasOutput:: @@ -37,7 +37,7 @@ mergetool.meld.hasOutput:: mergetool.meld.useAutoMerge:: When the `--auto-merge` is given, meld will merge all non-conflicting - parts automatically, highlight the conflicting parts and wait for + parts automatically, highlight the conflicting parts, and wait for user decision. Setting `mergetool.meld.useAutoMerge` to `true` tells Git to unconditionally use the `--auto-merge` option with `meld`. Setting this value to `auto` makes git detect whether `--auto-merge` @@ -55,7 +55,7 @@ endif::[] for details. mergetool.hideResolved:: - During a merge Git will automatically resolve as many conflicts as + During a merge, Git will automatically resolve as many conflicts as possible and write the 'MERGED' file containing conflict markers around any conflicts that it cannot resolve; 'LOCAL' and 'REMOTE' normally represent the versions of the file from before Git's conflict @@ -74,7 +74,7 @@ mergetool.keepTemporaries:: When invoking a custom merge tool, Git uses a set of temporary files to pass to the tool. If the tool returns an error and this variable is set to `true`, then these temporary files will be - preserved, otherwise they will be removed after the tool has + preserved; otherwise, they will be removed after the tool has exited. Defaults to `false`. mergetool.writeToTemp:: diff --git a/Documentation/config/push.txt b/Documentation/config/push.txt index dbaf930f01bbe4..0acbbea18a320f 100644 --- a/Documentation/config/push.txt +++ b/Documentation/config/push.txt @@ -67,7 +67,7 @@ new default). -- push.followTags:: - If set to true enable `--follow-tags` option by default. You + If set to true, enable `--follow-tags` option by default. You may override this configuration at time of push by specifying `--no-follow-tags`. diff --git a/Documentation/config/sequencer.txt b/Documentation/config/sequencer.txt index b48d532a96976b..e664eef01d10de 100644 --- a/Documentation/config/sequencer.txt +++ b/Documentation/config/sequencer.txt @@ -2,4 +2,4 @@ sequence.editor:: Text editor used by `git rebase -i` for editing the rebase instruction file. The value is meant to be interpreted by the shell when it is used. It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. - When not configured the default commit message editor is used instead. + When not configured, the default commit message editor is used instead. diff --git a/Documentation/config/splitindex.txt b/Documentation/config/splitindex.txt index afdb186df8ba6d..cfaa29610b5a00 100644 --- a/Documentation/config/splitindex.txt +++ b/Documentation/config/splitindex.txt @@ -3,10 +3,10 @@ splitIndex.maxPercentChange:: percent of entries the split index can contain compared to the total number of entries in both the split index and the shared index before a new shared index is written. - The value should be between 0 and 100. If the value is 0 then - a new shared index is always written, if it is 100 a new + The value should be between 0 and 100. If the value is 0, then + a new shared index is always written; if it is 100, a new shared index is never written. - By default the value is 20, so a new shared index is written + By default, the value is 20, so a new shared index is written if the number of entries in the split index would be greater than 20 percent of the total number of entries. See linkgit:git-update-index[1]. diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt index c1347fa7bcd7bf..2ffc38d164786f 100644 --- a/Documentation/config/user.txt +++ b/Documentation/config/user.txt @@ -8,11 +8,11 @@ committer.email:: up in the `author` and `committer` fields of commit objects. If you need the `author` or `committer` to be different, the - `author.name`, `author.email`, `committer.name` or + `author.name`, `author.email`, `committer.name`, or `committer.email` variables can be set. All of these can be overridden by the `GIT_AUTHOR_NAME`, `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`, - `GIT_COMMITTER_EMAIL` and `EMAIL` environment variables. + `GIT_COMMITTER_EMAIL`, and `EMAIL` environment variables. + Note that the `name` forms of these variables conventionally refer to some form of a personal name. See linkgit:git-commit[1] and the diff --git a/Documentation/config/versionsort.txt b/Documentation/config/versionsort.txt index 0d66617f59fc56..0cff0908193a29 100644 --- a/Documentation/config/versionsort.txt +++ b/Documentation/config/versionsort.txt @@ -19,7 +19,7 @@ with those suffixes. E.g. if "-pre" appears before "-rc" in the configuration, then all "1.0-preX" tags will be listed before any "1.0-rcX" tags. The placement of the main release tag relative to tags with various suffixes can be determined by specifying the empty suffix -among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and +among those other suffixes. E.g. if the suffixes "-rc", "", "-ck", and "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags are listed first, followed by "v4.8", then "v4.8-ckX" and finally "v4.8-bfsX". diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 988e33de70b5c4..4b5aa5c2e045f5 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -156,7 +156,7 @@ format, `/dev/null` is used to signal created or deleted files. + However, if the --combined-all-paths option is provided, instead of a -two-line from-file/to-file you get an N+1 line from-file/to-file header, +two-line from-file/to-file, you get an N+1 line from-file/to-file header, where N is the number of parents in the merge commit: --- a/file @@ -197,7 +197,7 @@ added, from the point of view of that parent). In the above example output, the function signature was changed from both files (hence two `-` removals from both file1 and file2, plus `++` to mean one line that was added does not appear -in either file1 or file2). Also eight other lines are the same +in either file1 or file2). Also, eight other lines are the same from file1 but do not appear in file2 (hence prefixed with `+`). When shown by `git diff-tree -c`, it compares the parents of a diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt index 9ee9fa659d2e03..a1d6633a4f15b7 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.txt @@ -96,7 +96,7 @@ endif::git-pull[] -f:: --force:: - When 'git fetch' is used with `:` refspec it may + When 'git fetch' is used with `:` refspec, it may refuse to update the local branch as discussed ifdef::git-pull[] in the `` part of the linkgit:git-fetch[1] diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 2ada047b6aa58c..0390dab20f9e6d 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -23,7 +23,7 @@ SYNOPSIS DESCRIPTION ----------- Splits mail messages in a mailbox into commit log messages, -authorship information and patches, and applies them to the +authorship information, and patches, and applies them to the current branch. You could think of it as a reverse operation of linkgit:git-format-patch[1] run on a branch with a straight history without merges. @@ -134,7 +134,7 @@ include::rerere-options.txt[] automatically. This option allows the user to bypass the automatic detection and specify the patch format that the patch(es) should be interpreted as. Valid formats are mbox, mboxrd, - stgit, stgit-series and hg. + stgit, stgit-series, and hg. -i:: --interactive:: diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index 95bde308709a07..9cce68a38be10f 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -23,8 +23,8 @@ DESCRIPTION Reads the supplied diff output (i.e. "a patch") and applies it to files. When running from a subdirectory in a repository, patched paths outside the directory are ignored. -With the `--index` option the patch is also applied to the index, and -with the `--cached` option the patch is only applied to the index. +With the `--index` option, the patch is also applied to the index, and +with the `--cached` option, the patch is only applied to the index. Without these options, the command applies the patch only to files, and does not require them to be in a Git repository. @@ -52,7 +52,7 @@ OPTIONS --summary:: Instead of applying the patch, output a condensed summary of information obtained from git diff extended - headers, such as creations, renames and mode changes. + headers, such as creations, renames, and mode changes. Turns off "apply". --check:: @@ -140,7 +140,7 @@ linkgit:git-config[1]). applying a diff generated with `--unified=0`. To bypass these checks use `--unidiff-zero`. + -Note, for the reasons stated above the usage of context-free patches is +Note, for the reasons stated above, the usage of context-free patches is discouraged. --apply:: @@ -161,7 +161,7 @@ discouraged. --binary:: Historically we did not allow binary patch application without an explicit permission from the user, and this - flag was the way to do so. Currently we always allow binary + flag was the way to do so. Currently, we always allow binary patch application, so this is a no-op. --exclude=:: diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt index 7fea245ed222c8..cb5a6c8f335e12 100644 --- a/Documentation/git-check-attr.txt +++ b/Documentation/git-check-attr.txt @@ -38,7 +38,7 @@ OPTIONS --source=:: Check attributes against the specified tree-ish. It is common to - specify the source tree by naming a commit, branch or tag associated + specify the source tree by naming a commit, branch, or tag associated with it. \--:: @@ -60,7 +60,7 @@ unless `-z` is in effect, in which case NUL is used as delimiter: is the path of a file being queried, is an attribute -being queried and can be either: +being queried, and can be either: 'unspecified';; when the attribute is not defined for the path. 'unset';; when the attribute is defined as false. diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index 4e2527612e0726..faf8d6ca36fb7c 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -57,7 +57,7 @@ OPTIONS Note: --stage=all automatically implies --temp. --temp:: - Instead of copying the files to the working directory + Instead of copying the files to the working directory, write the content to temporary files. The temporary name associations will be written to stdout. diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index 18f7f86bef3b14..bf78e314313813 100644 --- a/Documentation/git-diff-files.txt +++ b/Documentation/git-diff-files.txt @@ -26,7 +26,7 @@ include::diff-options.txt[] -2 --ours:: -3 --theirs:: -0:: - Diff against the "base" version, "our branch" or "their + Diff against the "base" version, "our branch", or "their branch" respectively. With these options, diffs for merged entries are not shown. + @@ -37,7 +37,7 @@ omit diff output for unmerged entries and just show "Unmerged". -c:: --cc:: This compares stage 2 (our branch), stage 3 (their - branch) and the working tree file and outputs a combined + branch), and the working tree file and outputs a combined diff, similar to the way 'diff-tree' shows a merge commit with these flags. diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index a6a054f86d2df2..bd7b1e0a2eaf3e 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -1353,7 +1353,7 @@ the marks back to the source repository, it is easy to verify the accuracy and completeness of the import by comparing each Git commit to the corresponding source revision. -Coming from a system such as Perforce or Subversion this should be +Coming from a system such as Perforce or Subversion, this should be quite simple, as the fast-import mark can also be the Perforce changeset number or the Subversion revision number. diff --git a/Documentation/git-fsmonitor--daemon.txt b/Documentation/git-fsmonitor--daemon.txt index 65c7b4641e875a..8585d19f4d8987 100644 --- a/Documentation/git-fsmonitor--daemon.txt +++ b/Documentation/git-fsmonitor--daemon.txt @@ -73,7 +73,7 @@ but it will not cause an incorrect result. By default, the fsmonitor daemon refuses to work with network-mounted repositories; this may be overridden by setting `fsmonitor.allowRemote` to `true`. Note, however, that the fsmonitor daemon is not guaranteed to work -correctly with all network-mounted repositories and such use is considered +correctly with all network-mounted repositories, so such use is considered experimental. On Mac OS, the inter-process communication (IPC) between various Git @@ -86,7 +86,7 @@ to work with these filesystems and such use is considered experimental. By default, the socket is created in the `.git` directory. However, if the `.git` directory is on a network-mounted filesystem, it will instead be created at `$HOME/.git-fsmonitor-*` unless `$HOME` itself is on a -network-mounted filesystem in which case you must set the configuration +network-mounted filesystem, in which case you must set the configuration variable `fsmonitor.socketDir` to the path of a directory on a Mac OS native filesystem in which to create the socket file. diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 22dfd7808515c0..7532625a1381dd 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -59,7 +59,7 @@ OPTIONS aliases. --verbose:: - When used with `--all` print description for all recognized + When used with `--all`, print description for all recognized commands. This is the default. -c:: @@ -129,8 +129,8 @@ line option: * "info" corresponds to '-i|--info', * "web" or "html" correspond to '-w|--web'. -help.browser, web.browser and browser..path -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +help.browser, web.browser, and browser..path +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The `help.browser`, `web.browser` and `browser..path` will also be checked if the 'web' format is chosen (either by command-line diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt index c0c841b9fddf47..ce0d8082125927 100644 --- a/Documentation/git-http-push.txt +++ b/Documentation/git-http-push.txt @@ -44,7 +44,7 @@ OPTIONS -d:: -D:: Remove from remote repository. The specified branch - cannot be the remote HEAD. If -d is specified the following + cannot be the remote HEAD. If -d is specified, the following other conditions must also be met: - Remote HEAD must resolve to an object that exists locally diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index cbc77f72588b5c..5ab957cfbc1420 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -88,7 +88,7 @@ For example, with this topology: the merge base between 'A' and 'B' is '1'. -Given three commits 'A', 'B' and 'C', `git merge-base A B C` will compute the +Given three commits 'A', 'B', and 'C', `git merge-base A B C` will compute the merge base between 'A' and a hypothetical commit 'M', which is a merge between 'B' and 'C'. For example, with this topology: @@ -204,7 +204,7 @@ will find B0, and $ git rebase --onto origin/master $fork_point topic -will replay D0, D1 and D on top of B to create a new history of this +will replay D0, D1, and D on top of B to create a new history of this shape: .... diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 7b7b6f8f344e15..b9e20c5dcd8c52 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -49,7 +49,7 @@ variable `mergetool..cmd`. + When 'git mergetool' is invoked with this tool (either through the `-t` or `--tool` option or the `merge.tool` configuration -variable) the configured command line will be invoked with `$BASE` +variable), the configured command line will be invoked with `$BASE` set to the name of a temporary file containing the common base for the merge, if available; `$LOCAL` set to the name of a temporary file containing the contents of the file on the current branch; @@ -81,7 +81,7 @@ success of the resolution after the custom tool has exited. -g:: --gui:: - When 'git-mergetool' is invoked with the `-g` or `--gui` option + When 'git-mergetool' is invoked with the `-g` or `--gui` option, the default merge tool will be read from the configured `merge.guitool` variable instead of `merge.tool`. If `merge.guitool` is not set, we will fallback to the tool diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt index fb0220fd18dc2b..7f991a3380201f 100644 --- a/Documentation/git-mv.txt +++ b/Documentation/git-mv.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -Move or rename a file, directory or symlink. +Move or rename a file, directory, or symlink. git mv [-v] [-f] [-n] [-k] git mv [-v] [-f] [-n] [-k] ... diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index 5c56c870253505..d4f1c4d5945e8e 100644 --- a/Documentation/git-name-rev.txt +++ b/Documentation/git-name-rev.txt @@ -26,7 +26,7 @@ OPTIONS --refs=:: Only use refs whose names match a given shell pattern. The pattern - can be one of branch name, tag name or fully qualified ref name. If + can be a branch name, a tag name, or a fully qualified ref name. If given multiple times, use refs whose names match any of the given shell patterns. Use `--no-refs` to clear any previous ref patterns given. diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt index 6ed71bd0b75af4..94700b89be99b7 100644 --- a/Documentation/git-remote-fd.txt +++ b/Documentation/git-remote-fd.txt @@ -13,10 +13,10 @@ DESCRIPTION ----------- This helper uses specified file descriptors to connect to a remote Git server. This is not meant for end users but for programs and scripts calling git -fetch, push or archive. +fetch, push, or archive. If only is given, it is assumed to be a bidirectional socket connected -to remote Git server (git-upload-pack, git-receive-pack or +to a remote Git server (git-upload-pack, git-receive-pack, or git-upload-archive). If both and are given, they are assumed to be pipes connected to a remote Git server ( being the inbound pipe and being the outbound pipe. diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt index d274002666ca4b..15dcbb6d91c89e 100644 --- a/Documentation/git-request-pull.txt +++ b/Documentation/git-request-pull.txt @@ -16,7 +16,7 @@ DESCRIPTION Generate a request asking your upstream project to pull changes into their tree. The request, printed to the standard output, begins with the branch description, summarizes -the changes and indicates from where they can be pulled. +the changes, and indicates from where they can be pulled. The upstream project is expected to have the commit named by `` and the output asks it to integrate the changes you made diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 4ef0872b4633e3..c771c897707873 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -125,7 +125,7 @@ OPTIONS default to color output. Same as `--color=never`. -Note that --more, --list, --independent and --merge-base options +Note that --more, --list, --independent, and --merge-base options are mutually exclusive. @@ -144,7 +144,7 @@ otherwise it shows a space. Merge commits are denoted by a `-` sign. Each commit shows a short name that can be used as an extended SHA-1 to name that commit. -The following example shows three branches, "master", "fixes" +The following example shows three branches, "master", "fixes", and "mhf": ------------------------------------------------ diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index e030dd75bede47..8c47890a6a89bd 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -160,7 +160,7 @@ you will need to handle the situation manually. --index-version :: Write the resulting index out in the named on-disk format version. - Supported versions are 2, 3 and 4. The current default version is 2 + Supported versions are 2, 3, and 4. The current default version is 2 or 3, depending on whether extra features are used, such as `git add -N`. With `--verbose`, also report the version the index file uses before and after this command. diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index bc65f91310d597..3cda2e07c24a96 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -231,7 +231,7 @@ like these: * -B/60 (the same as above, since diffcore-break defaults to 50%). Note that earlier implementation left a broken pair as separate -creation and deletion patches. This was an unnecessary hack and +creation and deletion patches. This was an unnecessary hack, and the latest implementation always merges all the broken pairs back into modifications, but the resulting patch output is formatted differently for easier review in case of such @@ -263,7 +263,7 @@ textual diff has an added or a deleted line that matches the given regular expression. This means that it will detect in-file (or what rename-detection considers the same file) moves, which is noise. The implementation runs diff twice and greps, and this can be quite -expensive. To speed things up binary files without textconv filters +expensive. To speed things up, binary files without textconv filters will be ignored. When `-S` or `-G` are used without `--pickaxe-all`, only filepairs diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt index 8fac3fcf9b41ce..4a4d87e7dbf5ce 100644 --- a/Documentation/gitformat-pack.txt +++ b/Documentation/gitformat-pack.txt @@ -18,7 +18,7 @@ DESCRIPTION ----------- The Git pack format is how Git stores most of its primary repository -data. Over the lifetime of a repository loose objects (if any) and +data. Over the lifetime of a repository, loose objects (if any) and smaller packs are consolidated into larger pack(s). See linkgit:git-gc[1] and linkgit:git-pack-objects[1]. diff --git a/Documentation/technical/api-simple-ipc.txt b/Documentation/technical/api-simple-ipc.txt index b4259098680ea6..c4fb152b23291c 100644 --- a/Documentation/technical/api-simple-ipc.txt +++ b/Documentation/technical/api-simple-ipc.txt @@ -25,7 +25,7 @@ When received, the response is returned back to the caller. For example, the `fsmonitor--daemon` feature will be built as a server application on top of the IPC-server library routines. It will have threads watching for file system events and a thread pool waiting for -client connections. Clients, such as `git status` will request a list +client connections. Clients, such as `git status`, will request a list of file system events since a point in time and the server will respond with a list of changed files and directories. The formats of the request and response are application-specific; the IPC-client and @@ -37,7 +37,7 @@ Comparison with sub-process model The Simple-IPC mechanism differs from the existing `sub-process.c` model (Documentation/technical/long-running-process-protocol.txt) and -used by applications like Git-LFS. In the LFS-style sub-process model +used by applications like Git-LFS. In the LFS-style sub-process model, the helper is started by the foreground process, communication happens via a pair of file descriptors bound to the stdin/stdout of the sub-process, the sub-process only serves the current foreground diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt index 82d919b26157d3..dd0b37c4e34738 100644 --- a/Documentation/technical/reftable.txt +++ b/Documentation/technical/reftable.txt @@ -175,7 +175,7 @@ log_index* footer .... -In a log-only file the first log block immediately follows the file +In a log-only file, the first log block immediately follows the file header, without padding to block alignment. Block size From 845c6ca90e806ac402cd9f1c981844531176475f Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:25 +0000 Subject: [PATCH 23/25] documentation: add missing fullstops Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/git-check-ref-format.txt | 2 +- Documentation/git-diff-tree.txt | 2 +- Documentation/git-help.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index 1d6e08e0119c7b..2aacfd18088d65 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -48,7 +48,7 @@ Git imposes the following rules on how references are named: . They cannot begin or end with a slash `/` or contain multiple consecutive slashes (see the `--normalize` option below for an - exception to this rule) + exception to this rule). . They cannot end with a dot `.`. diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 22380d5c829616..143318c411a076 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -34,7 +34,7 @@ include::diff-options.txt[] matching one of the provided pathspecs. -r:: - Recurse into sub-trees + Recurse into sub-trees. -t:: Show tree entry itself as well as subtrees. Implies -r. diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 7532625a1381dd..f0bedc1f96433e 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -42,7 +42,7 @@ former is internally converted into the latter. To display the linkgit:git[1] man page, use `git help git`. -This page can be displayed with 'git help help' or `git help --help` +This page can be displayed with 'git help help' or `git help --help`. OPTIONS ------- From 798cddfa513cec8084c9db2f7ba807dc1c9b3d44 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:26 +0000 Subject: [PATCH 24/25] documentation: add missing quotes Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/git-quiltimport.txt | 4 ++-- Documentation/technical/parallel-checkout.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt index 70562dc4c0235d..40e02d92eb2419 100644 --- a/Documentation/git-quiltimport.txt +++ b/Documentation/git-quiltimport.txt @@ -38,14 +38,14 @@ OPTIONS a patch. At the time of this writing only missing author information is warned about. ---author Author Name :: +--author 'Author Name ':: The author name and email address to use when no author information can be found in the patch description. --patches :: The directory to find the quilt patches. + -The default for the patch directory is patches +The default for the patch directory is 'patches' or the value of the `$QUILT_PATCHES` environment variable. diff --git a/Documentation/technical/parallel-checkout.txt b/Documentation/technical/parallel-checkout.txt index b5f54dcd4518fa..b4a144e5f4758d 100644 --- a/Documentation/technical/parallel-checkout.txt +++ b/Documentation/technical/parallel-checkout.txt @@ -126,7 +126,7 @@ Then, for each assigned item, each worker: * W5: Writes the result to the file descriptor opened at W2. -* W6: Calls `fstat()` or lstat()` on the just-written path, and sends +* W6: Calls `fstat()` or `lstat()` on the just-written path, and sends the result back to the main process, together with the end status of the operation and the item's identification number. From 5fbcdb2082ab5e154133048547c8f60c418b875c Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:27 +0000 Subject: [PATCH 25/25] documentation: add missing parenthesis Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/git-remote-fd.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt index 94700b89be99b7..1dd2648a7904bb 100644 --- a/Documentation/git-remote-fd.txt +++ b/Documentation/git-remote-fd.txt @@ -19,7 +19,7 @@ If only is given, it is assumed to be a bidirectional socket connected to a remote Git server (git-upload-pack, git-receive-pack, or git-upload-archive). If both and are given, they are assumed to be pipes connected to a remote Git server ( being the inbound pipe -and being the outbound pipe. +and being the outbound pipe). It is assumed that any handshaking procedures have already been completed (such as sending service request for git://) before this helper is started.