From: "Elijah Newren via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Elijah Newren <newren@gmail.com>, Elijah Newren <newren@gmail.com>
Subject: [PATCH 20/25] documentation: fix capitalization
Date: Sun, 08 Oct 2023 06:45:22 +0000 [thread overview]
Message-ID: <7c8422b0ca1e4b1c27d59846e5807c0363ddcc67.1696747529.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1595.git.1696747527.gitgitgadget@gmail.com>
From: Elijah Newren <newren@gmail.com>
Diff best viewed with --color-diff.
Signed-off-by: Elijah Newren <newren@gmail.com>
---
Documentation/config/checkout.txt | 2 +-
Documentation/config/user.txt | 2 +-
Documentation/git-diff-tree.txt | 4 ++--
Documentation/git-hook.txt | 2 +-
Documentation/git-mergetool--lib.txt | 10 +++++-----
Documentation/git-stripspace.txt | 2 +-
Documentation/git-update-server-info.txt | 2 +-
Documentation/technical/reftable.txt | 2 +-
8 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt
index a54faab238a..a3230229938 100644
--- a/Documentation/config/checkout.txt
+++ b/Documentation/config/checkout.txt
@@ -30,7 +30,7 @@ checkout.workers::
all commands that perform checkout. E.g. checkout, clone, reset,
sparse-checkout, etc.
+
-Note: parallel checkout usually delivers better performance for repositories
+Note: Parallel checkout usually delivers better performance for repositories
located on SSDs or over NFS. For repositories on spinning disks and/or machines
with a small number of cores, the default sequential checkout often performs
better. The size and compression level of a repository might also influence how
diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt
index 2bbc8e929f0..c1347fa7bcd 100644
--- a/Documentation/config/user.txt
+++ b/Documentation/config/user.txt
@@ -40,7 +40,7 @@ user.signingKey::
your private ssh key or the public key when ssh-agent is used.
Alternatively it can contain a public key prefixed with `key::`
directly (e.g.: "key::ssh-rsa XXXXXX identifier"). The private key
- needs to be available via ssh-agent. If not set git will call
+ needs to be available via ssh-agent. If not set Git will call
gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
first key available. For backward compatibility, a raw key which
begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index c2772a566a3..22380d5c829 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -34,10 +34,10 @@ include::diff-options.txt[]
matching one of the provided pathspecs.
-r::
- recurse into sub-trees
+ Recurse into sub-trees
-t::
- show tree entry itself as well as subtrees. Implies -r.
+ Show tree entry itself as well as subtrees. Implies -r.
--root::
When `--root` is specified the initial commit will be shown as a big
diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt
index 25237330b5c..f6cc72d2ca9 100644
--- a/Documentation/git-hook.txt
+++ b/Documentation/git-hook.txt
@@ -32,7 +32,7 @@ OPTIONS
-------
--to-stdin::
- For "run"; Specify a file which will be streamed into the
+ For "run"; specify a file which will be streamed into the
hook's stdin. The hook will receive the entire file from
beginning to EOF.
diff --git a/Documentation/git-mergetool--lib.txt b/Documentation/git-mergetool--lib.txt
index 3e8f59ac0e4..0726b560d43 100644
--- a/Documentation/git-mergetool--lib.txt
+++ b/Documentation/git-mergetool--lib.txt
@@ -28,22 +28,22 @@ to define the operation mode for the functions listed below.
FUNCTIONS
---------
get_merge_tool::
- returns a merge tool. the return code is 1 if we returned a guessed
+ Returns a merge tool. The return code is 1 if we returned a guessed
merge tool, else 0. '$GIT_MERGETOOL_GUI' may be set to 'true' to
search for the appropriate guitool.
get_merge_tool_cmd::
- returns the custom command for a merge tool.
+ Returns the custom command for a merge tool.
get_merge_tool_path::
- returns the custom path for a merge tool.
+ Returns the custom path for a merge tool.
initialize_merge_tool::
- bring merge tool specific functions into scope so they can be used or
+ Brings merge tool specific functions into scope so they can be used or
overridden.
run_merge_tool::
- launches a merge tool given the tool name and a true/false
+ Launches a merge tool given the tool name and a true/false
flag to indicate whether a merge base is present.
'$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined
for use by the merge tool.
diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt
index 6b92cc7de78..a293327581a 100644
--- a/Documentation/git-stripspace.txt
+++ b/Documentation/git-stripspace.txt
@@ -29,7 +29,7 @@ With no arguments, this will:
In the case where the input consists entirely of whitespace characters, no
output will be produced.
-*NOTE*: This is intended for cleaning metadata, prefer the `--whitespace=fix`
+*NOTE*: This is intended for cleaning metadata. Prefer the `--whitespace=fix`
mode of linkgit:git-apply[1] for correcting whitespace of patches or files in
the repository.
diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt
index ff32986d4c5..6bc9b50d89f 100644
--- a/Documentation/git-update-server-info.txt
+++ b/Documentation/git-update-server-info.txt
@@ -23,7 +23,7 @@ OPTIONS
-------
-f::
--force::
- update the info files from scratch.
+ Update the info files from scratch.
OUTPUT
------
diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt
index 6def498efd5..82d919b2615 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
--
gitgitgadget
next prev parent reply other threads:[~2023-10-08 6:46 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-08 6:45 [PATCH 00/25] Documentation fixes Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 01/25] documentation: wording improvements Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 02/25] documentation: fix small error Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 03/25] documentation: fix typos Elijah Newren via GitGitGadget
2023-10-08 16:32 ` Ramsay Jones
2023-10-09 19:01 ` Junio C Hamano
2023-10-10 0:57 ` Elijah Newren
2023-10-08 6:45 ` [PATCH 04/25] documentation: fix apostrophe usage Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 05/25] documentation: add missing words Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 06/25] documentation: remove extraneous words Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 07/25] documentation: fix subject/verb agreement Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 08/25] documentation: employ consistent verb tense for a list Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 09/25] documentation: fix verb tense Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 10/25] documentation: fix adjective vs. noun Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 11/25] documentation: fix verb " Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 12/25] documentation: fix singular vs. plural Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 13/25] documentation: whitespace is already generally plural Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 14/25] documentation: fix choice of article Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 15/25] documentation: add missing article Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 16/25] documentation: remove unnecessary hyphens Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 17/25] documentation: add missing hyphens Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 18/25] documentation: use clearer prepositions Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 19/25] documentation: fix punctuation Elijah Newren via GitGitGadget
2023-10-08 6:45 ` Elijah Newren via GitGitGadget [this message]
2023-10-08 6:45 ` [PATCH 21/25] documentation: fix whitespace issues Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 22/25] documentation: add some commas where they are helpful Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 23/25] documentation: add missing fullstops Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 24/25] documentation: add missing quotes Elijah Newren via GitGitGadget
2023-10-08 6:45 ` [PATCH 25/25] documentation: add missing parenthesis Elijah Newren via GitGitGadget
2023-10-09 1:44 ` [PATCH 00/25] Documentation fixes Taylor Blau
2023-10-09 16:46 ` Elijah Newren
2023-10-16 21:54 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7c8422b0ca1e4b1c27d59846e5807c0363ddcc67.1696747529.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=newren@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).