From cf6cac20059123d6ec3f867bb3692df62db52cf9 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:03 +0000 Subject: documentation: wording improvements Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- Documentation/diff-generate-patch.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/diff-generate-patch.txt') diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 546adf79e5..55df903abd 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 -- cgit v1.3 From 859a6d6045e338a337cb7499100b1fa31c367fbf Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:08 +0000 Subject: 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(-) (limited to 'Documentation/diff-generate-patch.txt') diff --git a/Documentation/config/branch.txt b/Documentation/config/branch.txt index 2b05ed3574..3bec6daf71 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 a31faab2ed..248d99d70b 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 5f96cf87fb..6e04fbe4f4 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 51b1b5fe7e..792e68a445 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 55df903abd..49ad31fca2 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 81caad5c95..37ca32c396 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 8238eadb0e..f50a28b09f 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 63eb030b34..34e2c656de 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 1486651bd1..cdc9d6e707 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 fcc2b25ee9..21b73b7a1f 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 26bf06d991..74143ef0d2 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 1a5fe09b51..b5f54dcd45 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 1719c723f5..29876ca582 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 5f4dd7c102..580f23360a 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 ae8c2db427..3504afbf2e 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. -- cgit v1.3 From 6cc668c0abd65415a461c6dddfefffaaeb1d5adc Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:14 +0000 Subject: 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(-) (limited to 'Documentation/diff-generate-patch.txt') diff --git a/Documentation/ToolsForGit.txt b/Documentation/ToolsForGit.txt index 5d01e8191a..209eaad31e 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 c8e38a0e5c..c5cde1c24e 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 9f30322362..01e4198429 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 9391c77e55..bd5ae0c337 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 c1a7cdd6bf..aea5b97477 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 3854d4ae37..ec3a5d81f7 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 40abdf6a6b..3a78b5ebb1 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 958e62464a..2bbc8e929f 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 6c7cc054fa..0d66617f59 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 49ad31fca2..65e0b1646e 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 900be198b1..51c2671515 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 ffc4fbf7e8..9f951c7fe3 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 cbc0ece61e..882ec056a3 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 f271d758c3..fdd2e0f088 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 e76c262d7f..9c1ed757b9 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 58cf6210cd..080b5246a4 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 03c0634518..5eb67439af 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 1271486ae9..7f0c950a5f 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 ee8c1aa0ca..fc2dc5a3b1 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 f0986881ba..71ffe5556a 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 5681ba3f33..411ce86359 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 faba2ef088..12b62b9125 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 34e2c656de..e62ad343ed 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 13678ead04..8400d591da 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 c36c547939..d1a4c468e6 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 eda8c195c1..7780a76b08 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 02ae508d22..59bea66c0f 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 8ef664b0b9..045a76756f 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 3504afbf2e..bf17012241 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: -- cgit v1.3 From 3771d002571f6fc796ff3f54e9d5b875826e62ed Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:16 +0000 Subject: 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(-) (limited to 'Documentation/diff-generate-patch.txt') diff --git a/Documentation/config.txt b/Documentation/config.txt index 9273c7f1c6..99affec5a0 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 65e0b1646e..4b307cb51b 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 29c473e5e0..013014bbef 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 335395b727..15c6f2705d 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 687c58cebc..f761828f10 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). -- cgit v1.3 From 0a4f051f9318c3dd9db69c4bebecdc6d160a5fc6 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:17 +0000 Subject: 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(-) (limited to 'Documentation/diff-generate-patch.txt') diff --git a/Documentation/ReviewingGuidelines.txt b/Documentation/ReviewingGuidelines.txt index 0e323d5477..3e98c8a6af 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 c5cde1c24e..2737381a11 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 bcb46cf630..62f0d92fda 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 0687e86ba1..5711416106 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 17e2a8cc17..31f1fff53c 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 0c087fd8c9..171be774d2 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 a727d987a8..5a0f82cc23 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 c7c4811734..43db8e808d 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 792e68a445..7fc770ee9e 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 b9f609ed76..ec1edaeba6 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 4b307cb51b..cf1958ca63 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 8505c244bc..f643585a34 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 51c2671515..00a5ec206d 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 b6e7510d06..95bde30870 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 a927c7c9f3..6f39147c05 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 ee6a4144fb..1d6e08e011 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 d1738f4330..4e2527612e 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 b28cc3a510..97f9f12610 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 236df516c7..e064f91c9e 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 1e34f80daa..c2772a566a 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 179e5ae216..50cb080085 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 e4980d2861..5b82e4605c 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 ee18a2b743..22dfd78085 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 8b4a5791c8..c0c841b9fd 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 138dc4a3bf..3c3c1e730c 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 e3b2a88c4b..3f0a6662c8 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 b01ba3d356..463764b9c1 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 9f951c7fe3..b50acace3b 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 7a01496234..006d759962 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 03552dd86f..9a45571b90 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 5b4edaf4a8..c12caedbb1 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 3206531853..1c48c28996 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 65ff518ccf..20aca92073 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 17d84f23c9..b33ee3c9e8 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 0451ceb8a2..6ed71bd0b7 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 fdd2e0f088..4f257126e3 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 7b3ce3012e..f42fb93870 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 9c1ed757b9..b9e73f2e77 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 8632612c31..bdaf6e5fc4 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 080b5246a4..ddf24aeb87 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 3dc630da4b..6b92cc7de7 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 7f0c950a5f..7ac2e37c0a 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 48b6683071..0561808cca 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 17e429dbd0..ff32986d4c 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 b8720dce8a..d7e886918a 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 fc2dc5a3b1..8e55e0bb1e 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 71ffe5556a..e5fac94322 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 411ce86359..bc65f91310 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 992f9d7d37..8fac3fcf9b 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 e62ad343ed..883982e7a0 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 388846d92e..d6c6effc21 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 41ce55e266..1030e9667e 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 15c6f2705d..23888cd612 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 74143ef0d2..c718f7946f 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 66d71d1b95..2bf239ff03 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 f761828f10..f5d200939b 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 29876ca582..cd948b0072 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 -- cgit v1.3 From 9a9fd289cc81a3bb69eb2b4e11db27509e0eb515 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:20 +0000 Subject: 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(-) (limited to 'Documentation/diff-generate-patch.txt') diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 973d7a81d4..0e2d3fbb9c 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 3bec6daf71..432b9cd2c0 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 cc25621731..6e72fdb45b 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 cf1958ca63..988e33de70 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 00a5ec206d..2ada047b6a 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 591e3801b7..18f7f86bef 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 f50a28b09f..324299bfe9 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 3407f3c2c0..25237330b5 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 5cdcb5663c..cbc77f7258 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 800a3cbe6f..7b7b6f8f34 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 fa5a426709..d274002666 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 f42fb93870..912fab9f5e 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 ddf24aeb87..4ef0872b46 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 7ac2e37c0a..e030dd75be 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 -- cgit v1.3 From 4d542687fcea27c6cce9a79415ad8cb1a817697c Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 8 Oct 2023 06:45:24 +0000 Subject: 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(-) (limited to 'Documentation/diff-generate-patch.txt') diff --git a/Documentation/ToolsForGit.txt b/Documentation/ToolsForGit.txt index 209eaad31e..ae7690b45d 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 a807c925b9..f05b9403b5 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 1795b2d16b..2f2275ac69 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 075ef8c975..0221c3e620 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 c1166e330d..903677d7ef 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 2384c8c94d..8e9e508933 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 6e04fbe4f4..9003a82191 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 99e83dd36e..8851b6cede 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 fe4ba0271b..294f61efd1 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 dbaf930f01..0acbbea18a 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 b48d532a96..e664eef01d 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 afdb186df8..cfaa29610b 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 c1347fa7bc..2ffc38d164 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 0d66617f59..0cff090819 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 988e33de70..4b5aa5c2e0 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 9ee9fa659d..a1d6633a4f 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 2ada047b6a..0390dab20f 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 95bde30870..9cce68a38b 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 7fea245ed2..cb5a6c8f33 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 4e2527612e..faf8d6ca36 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 18f7f86bef..bf78e31431 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 a6a054f86d..bd7b1e0a2e 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 65c7b4641e..8585d19f4d 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 22dfd78085..7532625a13 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 c0c841b9fd..ce0d808212 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 cbc77f7258..5ab957cfbc 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 7b7b6f8f34..b9e20c5dcd 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 fb0220fd18..7f991a3380 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 5c56c87025..d4f1c4d594 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 6ed71bd0b7..94700b89be 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 d274002666..15dcbb6d91 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 4ef0872b46..c771c89770 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 e030dd75be..8c47890a6a 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 bc65f91310..3cda2e07c2 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 8fac3fcf9b..4a4d87e7db 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 b425909868..c4fb152b23 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 82d919b261..dd0b37c4e3 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 -- cgit v1.3