git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 20/25] documentation: fix capitalization

From
Elijah Newren via GitGitGadget <gitgitgadget@gmail.com>
Date
Oct 8, 2023, 06:45 UTC
Message-ID
<7c8422b0ca1e4b1c27d59846e5807c0363ddcc67.1696747529.git.gitgitgadget@gmail.com>
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
Previous: Elijah Newren via GitGitGadgetNext: Elijah Newren via GitGitGadget
Message 25 of 32 in “Documentation fixes”
  1. 00/25 Documentation fixesElijah Newren via GitGitGadget, Oct 8, 2023
  2. 03/25 documentation: fix typosElijah Newren via GitGitGadget, Oct 8, 2023
  3. Ramsay JonesOct 8, 2023
  4. Junio C HamanoOct 9, 2023
  5. Elijah NewrenOct 10, 2023
  6. 02/25 documentation: fix small errorElijah Newren via GitGitGadget, Oct 8, 2023
  7. 04/25 documentation: fix apostrophe usageElijah Newren via GitGitGadget, Oct 8, 2023
  8. 05/25 documentation: add missing wordsElijah Newren via GitGitGadget, Oct 8, 2023
  9. 06/25 documentation: remove extraneous wordsElijah Newren via GitGitGadget, Oct 8, 2023
  10. 08/25 documentation: employ consistent verb tense for a listElijah Newren via GitGitGadget, Oct 8, 2023
  11. 10/25 documentation: fix adjective vs. nounElijah Newren via GitGitGadget, Oct 8, 2023
  12. 09/25 documentation: fix verb tenseElijah Newren via GitGitGadget, Oct 8, 2023
  13. 11/25 documentation: fix verb vs. nounElijah Newren via GitGitGadget, Oct 8, 2023
  14. 07/25 documentation: fix subject/verb agreementElijah Newren via GitGitGadget, Oct 8, 2023
  15. 01/25 documentation: wording improvementsElijah Newren via GitGitGadget, Oct 8, 2023
  16. 14/25 documentation: fix choice of articleElijah Newren via GitGitGadget, Oct 8, 2023
  17. 13/25 documentation: whitespace is already generally pluralElijah Newren via GitGitGadget, Oct 8, 2023
  18. 16/25 documentation: remove unnecessary hyphensElijah Newren via GitGitGadget, Oct 8, 2023
  19. 17/25 documentation: add missing hyphensElijah Newren via GitGitGadget, Oct 8, 2023
  20. 12/25 documentation: fix singular vs. pluralElijah Newren via GitGitGadget, Oct 8, 2023
  21. 18/25 documentation: use clearer prepositionsElijah Newren via GitGitGadget, Oct 8, 2023
  22. 21/25 documentation: fix whitespace issuesElijah Newren via GitGitGadget, Oct 8, 2023
  23. 19/25 documentation: fix punctuationElijah Newren via GitGitGadget, Oct 8, 2023
  24. 23/25 documentation: add missing fullstopsElijah Newren via GitGitGadget, Oct 8, 2023
  25. 20/25 documentation: fix capitalizationElijah Newren via GitGitGadget, Oct 8, 2023
  26. 24/25 documentation: add missing quotesElijah Newren via GitGitGadget, Oct 8, 2023
  27. 15/25 documentation: add missing articleElijah Newren via GitGitGadget, Oct 8, 2023
  28. 25/25 documentation: add missing parenthesisElijah Newren via GitGitGadget, Oct 8, 2023
  29. 22/25 documentation: add some commas where they are helpfulElijah Newren via GitGitGadget, Oct 8, 2023
  30. Taylor BlauOct 9, 2023
  31. Elijah NewrenOct 9, 2023
  32. Junio C HamanoOct 16, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.