[18/25] documentation: use clearer prepositions

Message ID	067474826a76d1db15570cc410a9d251cfe973dd.1696747529.git.gitgitgadget@gmail.com (mailing list archive)
State	Accepted
Commit	9a9fd289cc81a3bb69eb2b4e11db27509e0eb515
Headers	show Return-Path: <git-owner@vger.kernel.org> Message-ID: <067474826a76d1db15570cc410a9d251cfe973dd.1696747529.git.gitgitgadget@gmail.com> In-Reply-To: <pull.1595.git.1696747527.gitgitgadget@gmail.com> References: <pull.1595.git.1696747527.gitgitgadget@gmail.com> Date: Sun, 08 Oct 2023 06:45:20 +0000 Subject: [PATCH 18/25] documentation: use clearer prepositions Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MIME-Version: 1.0 To: git@vger.kernel.org Cc: Elijah Newren <newren@gmail.com>, Elijah Newren <newren@gmail.com> Precedence: bulk From: Elijah Newren <newren@gmail.com>
Series	Documentation fixes \| expand [00/25] Documentation fixes [01/25] documentation: wording improvements [02/25] documentation: fix small error [03/25] documentation: fix typos [04/25] documentation: fix apostrophe usage [05/25] documentation: add missing words [06/25] documentation: remove extraneous words [07/25] documentation: fix subject/verb agreement [08/25] documentation: employ consistent verb tense for a list [09/25] documentation: fix verb tense [10/25] documentation: fix adjective vs. noun [11/25] documentation: fix verb vs. noun [12/25] documentation: fix singular vs. plural [13/25] documentation: whitespace is already generally plural [14/25] documentation: fix choice of article [15/25] documentation: add missing article [16/25] documentation: remove unnecessary hyphens [17/25] documentation: add missing hyphens [18/25] documentation: use clearer prepositions [19/25] documentation: fix punctuation [20/25] documentation: fix capitalization [21/25] documentation: fix whitespace issues [22/25] documentation: add some commas where they are helpful [23/25] documentation: add missing fullstops [24/25] documentation: add missing quotes [25/25] documentation: add missing parenthesis

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 973d7a81d44..0e2d3fbb9cc 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 3bec6daf71a..432b9cd2c0e 100644 --- a/Documentation/config/branch.txt +++ b/Documentation/config/branch.txt @@ -99,5 +99,5 @@ for details). branch.<name>.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 cc256217317..6e72fdb45bd 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 cf1958ca632..988e33de70b 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 00a5ec206d6..2ada047b6aa 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 591e3801b7b..18f7f86bef3 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 f50a28b09f9..324299bfe9b 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 3407f3c2c07..25237330b5c 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 5cdcb5663cd..cbc77f72588 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 <ref> to see if the history leading to <commit> forked from an earlier incarnation of the branch <ref> (see discussion - on this mode below). + of this mode below). OPTIONS ------- diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 800a3cbe6f3..7b7b6f8f344 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 <file> 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 <file> 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 fa5a4267092..d274002666c 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 f42fb938705..912fab9f5e0 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 ddf24aeb87d..4ef0872b463 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 7ac2e37c0ac..e030dd75bed 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

[18/25] documentation: use clearer prepositions

Commit Message

Patch