[PATCH 0/6] Documentation fixes for changes made this cycle

[PATCH 0/6] Documentation fixes for changes made this cycle

[Elijah Newren via GitGitGadget]

This series fixes some simple documentation issues in the release notes,
Coding Guidelines, and regular documentation, all of which address issues
new to this cycle.

Elijah Newren (6):
  RelNotes/2.54.0: fix typos and grammar
  CodingGuidelines: fix subject-verb agreement
  doc: fix self-referential config in sendemail.smtpSSLClientKey
  doc: fix plural agreement in pack.preferBitmapTips
  doc: fix singular/plural mismatch in git-rerere
  doc: fix grammar errors in submodule description

 Documentation/CodingGuidelines      |  2 +-
 Documentation/RelNotes/2.54.0.adoc  | 20 ++++++++++----------
 Documentation/config/pack.adoc      |  2 +-
 Documentation/config/sendemail.adoc |  2 +-
 Documentation/config/submodule.adoc |  2 +-
 Documentation/git-rerere.adoc       |  2 +-
 Documentation/gitmodules.adoc       |  8 ++++----
 7 files changed, 19 insertions(+), 19 deletions(-)


base-commit: 9f223ef1c026d91c7ac68cc0211bde255dda6199
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2092%2Fnewren%2Ffix%2Fdoc-fixes-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2092/newren/fix/doc-fixes-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/2092
-- 
gitgitgadget

[PATCH 1/6] RelNotes/2.54.0: fix typos and grammar

[Elijah Newren via GitGitGadget]

From: Elijah Newren <newren@gmail.com>

Fix various issues in the release notes -- missing/wrong articles, typo,
indentation, quote consistency, and wording improvement or corrections.

Other than the indentation fix for "The way combined list-object filter
options...", this patch is much easier to view with --color-words.

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/RelNotes/2.54.0.adoc | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/RelNotes/2.54.0.adoc b/Documentation/RelNotes/2.54.0.adoc
index 2ad73ff473..7bfc351c9a 100644
--- a/Documentation/RelNotes/2.54.0.adoc
+++ b/Documentation/RelNotes/2.54.0.adoc
@@ -36,7 +36,7 @@ UI, Workflows & Features
  * Extend the alias configuration syntax to allow aliases using
    characters outside ASCII alphanumeric (plus '-').
 
- * A signature on a commit that was GPG signed long time ago ought to
+ * A signature on a commit that was GPG signed a long time ago ought to
    be still valid after the key that was used to sign it has expired,
    but we showed them in alarming red.
 
@@ -88,7 +88,7 @@ UI, Workflows & Features
  * "git repo structure" command learns to report maximum values on
    various aspects of objects it inspects.
 
- * "git rebase" learns "--trailer" command to drive the
+ * "git rebase" learns "--trailer" option to drive the
    interpret-trailers machinery.
 
  * "git fast-import" learned to optionally replace signature on
@@ -119,7 +119,7 @@ UI, Workflows & Features
  * "git replay" (experimental) learns, in addition to "pick" and
    "replay", a new operating mode "revert".
 
- * git replay now supports replaying down to the root commit.
+ * "git replay" now supports replaying down to the root commit.
 
  * Handling of signed commits and tags in fast-import has been made more
    configurable.
@@ -207,7 +207,7 @@ Performance, Internal Implementation, Development Support etc.
    from getting added.
 
  * The core.attributesfile is intended to be set per repository, but
-   were kept track of by a single global variable in-core, which has
+   was kept track of by a single global variable in-core, which has
    been corrected by moving it to per-repository data structure.
 
  * Use the hook API to replace ad-hoc invocation of hook scripts via
@@ -232,8 +232,8 @@ Performance, Internal Implementation, Development Support etc.
  * Reduce dependence on the global the_hash_algo and the_repository
    variables of wt-status code path.
 
-  * The way combined list-object filter options are parsed has been
-    revamped.
+ * The way combined list-object filter options are parsed has been
+   revamped.
 
  * Editorconfig filename patterns were specified incorrectly, making
    many source files inside subdirectories unaffected, which has been
@@ -272,7 +272,7 @@ Performance, Internal Implementation, Development Support etc.
  * split-index.c has been updated to not use the global the_repository
    and the_hash_algo variables.
 
- * The unsigned integer that is used as an bitset to specify the kind
+ * The unsigned integer that is used as a bitset to specify the kind
    of branches interpret_branch_name() function has been changed to
    use a dedicated enum type.
 
@@ -282,7 +282,7 @@ Performance, Internal Implementation, Development Support etc.
  * Code paths that loop over another array to push each element into a
    strvec have been rewritten to use strvec_pushv() instead.
 
- * In case homebrew breaks REG_ENHANCED again, leave a in-code comment
+ * In case homebrew breaks REG_ENHANCED again, leave an in-code comment
    to suggest use of our replacement regex as a workaround.
 
  * MinGW build updates.
@@ -382,7 +382,7 @@ Fixes since v2.53
    (merge f4eff7116d ps/pack-concat-wo-backfill later to maint).
 
  * "git switch <name>", in an attempt to create a local branch <name>
-   after a remote tracking branch of the same name gave an advise
+   after a remote tracking branch of the same name gave an advice
    message to disambiguate using "git checkout", which has been
    updated to use "git switch".
    (merge 12fee11f21 jc/checkout-switch-restore later to maint).
@@ -396,7 +396,7 @@ Fixes since v2.53
  * "git format-patch --from=<me>" did not honor the command line
    option when writing out the cover letter, which has been corrected.
 
- * Update build precedure for mergetool documentation in meson-based builds.
+ * Update build procedure for mergetool documentation in meson-based builds.
    (merge 58e4eeeeb5 pw/meson-doc-mergetool later to maint).
 
  * An earlier attempt to optimize "git subtree" discarded too much
-- 
gitgitgadget

[PATCH 2/6] CodingGuidelines: fix subject-verb agreement

[Elijah Newren via GitGitGadget]

From: Elijah Newren <newren@gmail.com>

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/CodingGuidelines | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 4992e52093..2aafcec40d 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -688,7 +688,7 @@ For C programs:
          walk_dog(dog[1]);
 
    Cases where the array is employed as a whole rather than as its unit parts,
-   the plural forms is preferable. E.g:
+   the plural form is preferable. E.g:
 
          char *dogs[] = ...;
          walk_all_dogs(dogs);
-- 
gitgitgadget

[PATCH 3/6] doc: fix self-referential config in sendemail.smtpSSLClientKey

[Elijah Newren via GitGitGadget]

From: Elijah Newren <newren@gmail.com>

a8215a205141 (send-email: add client certificate options, 2026-03-02)
added documentation for sendemail.smtpSSLClientKey that says it works
"in conjunction with `sendemail.smtpSSLClientKey`" -- referring to
itself.  It appears that `sendemail.smtpSSLClientCert` was the intended
reference; fix it.

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/config/sendemail.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/config/sendemail.adoc b/Documentation/config/sendemail.adoc
index 6560ecc5ab..1d700559b4 100644
--- a/Documentation/config/sendemail.adoc
+++ b/Documentation/config/sendemail.adoc
@@ -22,7 +22,7 @@ sendemail.smtpSSLClientCert::
 sendemail.smtpSSLClientKey::
 	Path to the client private key file that corresponds to the client
 	certificate. To avoid misconfiguration, this configuration must be used
-	in conjunction with `sendemail.smtpSSLClientKey` or the
+	in conjunction with `sendemail.smtpSSLClientCert` or the
 	`--smtp-ssl-client-cert` option. If the client key is included in the
 	client certificate, the choice of private key depends on the format of
 	the certificate. Visit https://metacpan.org/pod/IO::Socket::SSL for more
-- 
gitgitgadget

[PATCH 4/6] doc: fix plural agreement in pack.preferBitmapTips

[Elijah Newren via GitGitGadget]

From: Elijah Newren <newren@gmail.com>

hierarchies -> hierarchy

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/config/pack.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/config/pack.adoc b/Documentation/config/pack.adoc
index fa997c8597..22384c2d2f 100644
--- a/Documentation/config/pack.adoc
+++ b/Documentation/config/pack.adoc
@@ -161,7 +161,7 @@ pack.usePathWalk::
 
 pack.preferBitmapTips::
 	Specifies a ref hierarchy (e.g., "refs/heads/"); can be
-	given multiple times to specify more than one hierarchies.
+	given multiple times to specify more than one hierarchy.
 	When selecting which commits will receive bitmaps, prefer a
 	commit at the tip of a reference that is contained in any of
 	the configured hierarchies.
-- 
gitgitgadget

[PATCH 5/6] doc: fix singular/plural mismatch in git-rerere

[Elijah Newren via GitGitGadget]

From: Elijah Newren <newren@gmail.com>

conflict -> conflicts

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/git-rerere.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-rerere.adoc b/Documentation/git-rerere.adoc
index 99f967b7a4..4e6ab9a27c 100644
--- a/Documentation/git-rerere.adoc
+++ b/Documentation/git-rerere.adoc
@@ -44,7 +44,7 @@ will automatically invoke this command.
 'forget' <pathspec>::
 
 Reset the conflict resolutions which rerere has recorded for the current
-conflict in paths that match <pathspec>.
+conflicts in paths that match <pathspec>.
 
 'diff'::
 
-- 
gitgitgadget

[PATCH 6/6] doc: fix grammar errors in submodule description

[Elijah Newren via GitGitGadget]

From: Elijah Newren <newren@gmail.com>

6cc6d1b4c699 (Documentation: update add --force option + ignore=all
config, 2026-02-06) added text describing both the ignore=none and
ignore=all behaviors.  The former had minor formatting and grammatical
errors, while the latter was a bit garbled.  I have tried to tweak the
wording on the latter to make it read as I think was intended, and fixed
the minor grammatical issues with both as well.

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/config/submodule.adoc | 2 +-
 Documentation/gitmodules.adoc       | 8 ++++----
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/config/submodule.adoc b/Documentation/config/submodule.adoc
index 8dacb852c7..4c424017b4 100644
--- a/Documentation/config/submodule.adoc
+++ b/Documentation/config/submodule.adoc
@@ -40,7 +40,7 @@ submodule.<name>.ignore::
 	takes only differences between the HEAD of the submodule and the commit
 	recorded in the superproject into account. "untracked" will additionally
 	let submodules with modified tracked files in their work tree show up.
-	When set to "none"(default) It also show submodules as changed if they have
+	When set to "none" (default) it also shows submodules as changed if they have
 	untracked files in their work tree.
 	This setting overrides any setting made in .gitmodules for this submodule,
 	both settings can be overridden on the command line by using the
diff --git a/Documentation/gitmodules.adoc b/Documentation/gitmodules.adoc
index 3792da96aa..fd96639806 100644
--- a/Documentation/gitmodules.adoc
+++ b/Documentation/gitmodules.adoc
@@ -70,10 +70,10 @@ submodule.<name>.ignore::
 --
 	all;; The submodule will never be considered modified (but will
 	    nonetheless show up in the output of status and commit when it has
-	    been staged). Add `(new commits)` can be overruled using the
-	    `git add --force <submodule.path>`.
-		The setting affects `status`, `update-index`, `diff` and `log`(due
-		to underlaying `diff`).
+	    been staged).  Adding a submodule with `(new commits)` can be
+	    overridden using `git add --force <submodule.path>`.
+	    This setting affects `status`, `update-index`, `diff` and `log`
+	    (due to underlying `diff`).
 
 	dirty;; All changes to the submodule's work tree will be ignored, only
 	    committed differences between the `HEAD` of the submodule and its
-- 
gitgitgadget