{"thread":{"id":"65503","subject":"[PATCH 0/6] Documentation fixes for changes made this cycle","startedAt":"2026-04-16T23:36:34Z","lastAt":"2026-04-16T23:36:42Z","messageCount":7,"participants":["Elijah Newren via GitGitGadget"],"isPatch":true,"patchVersion":1,"patchTotal":6},"messages":[{"id":"541793","messageId":"pull.2092.git.1776382591.gitgitgadget@gmail.com","threadId":"65503","inReplyTo":null,"subject":"[PATCH 0/6] Documentation fixes for changes made this cycle","fromName":"Elijah Newren via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2026-04-16T23:36:25Z","receivedAt":"2026-04-16T23:36:34Z","isPatch":true,"body":"This series fixes some simple documentation issues in the release notes,\nCoding Guidelines, and regular documentation, all of which address issues\nnew to this cycle.\n\nElijah Newren (6):\n RelNotes/2.54.0: fix typos and grammar\n CodingGuidelines: fix subject-verb agreement\n doc: fix self-referential config in sendemail.smtpSSLClientKey\n doc: fix plural agreement in pack.preferBitmapTips\n doc: fix singular/plural mismatch in git-rerere\n doc: fix grammar errors in submodule description\n\n Documentation/CodingGuidelines | 2 +-\n Documentation/RelNotes/2.54.0.adoc | 20 ++++++++++----------\n Documentation/config/pack.adoc | 2 +-\n Documentation/config/sendemail.adoc | 2 +-\n Documentation/config/submodule.adoc | 2 +-\n Documentation/git-rerere.adoc | 2 +-\n Documentation/gitmodules.adoc | 8 ++++----\n 7 files changed, 19 insertions(+), 19 deletions(-)\n\n\nbase-commit: 9f223ef1c026d91c7ac68cc0211bde255dda6199\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-2092%2Fnewren%2Ffix%2Fdoc-fixes-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2092/newren/fix/doc-fixes-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/2092\n-- \ngitgitgadget\n"},{"id":"541794","messageId":"d0cfc298870405cda95d382f3eab827c5034bf68.1776382591.git.gitgitgadget@gmail.com","threadId":"65503","inReplyTo":"pull.2092.git.1776382591.gitgitgadget@gmail.com","subject":"[PATCH 1/6] RelNotes/2.54.0: fix typos and grammar","fromName":"Elijah Newren via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2026-04-16T23:36:26Z","receivedAt":"2026-04-16T23:36:35Z","isPatch":true,"body":"From: Elijah Newren \n\nFix various issues in the release notes -- missing/wrong articles, typo,\nindentation, quote consistency, and wording improvement or corrections.\n\nOther than the indentation fix for \"The way combined list-object filter\noptions...\", this patch is much easier to view with --color-words.\n\nSigned-off-by: Elijah Newren \n---\n Documentation/RelNotes/2.54.0.adoc | 20 ++++++++++----------\n 1 file changed, 10 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/RelNotes/2.54.0.adoc b/Documentation/RelNotes/2.54.0.adoc\nindex 2ad73ff473..7bfc351c9a 100644\n--- a/Documentation/RelNotes/2.54.0.adoc\n+++ b/Documentation/RelNotes/2.54.0.adoc\n@@ -36,7 +36,7 @@ UI, Workflows & Features\n * Extend the alias configuration syntax to allow aliases using\n characters outside ASCII alphanumeric (plus '-').\n \n- * A signature on a commit that was GPG signed long time ago ought to\n+ * A signature on a commit that was GPG signed a long time ago ought to\n be still valid after the key that was used to sign it has expired,\n but we showed them in alarming red.\n \n@@ -88,7 +88,7 @@ UI, Workflows & Features\n * \"git repo structure\" command learns to report maximum values on\n various aspects of objects it inspects.\n \n- * \"git rebase\" learns \"--trailer\" command to drive the\n+ * \"git rebase\" learns \"--trailer\" option to drive the\n interpret-trailers machinery.\n \n * \"git fast-import\" learned to optionally replace signature on\n@@ -119,7 +119,7 @@ UI, Workflows & Features\n * \"git replay\" (experimental) learns, in addition to \"pick\" and\n \"replay\", a new operating mode \"revert\".\n \n- * git replay now supports replaying down to the root commit.\n+ * \"git replay\" now supports replaying down to the root commit.\n \n * Handling of signed commits and tags in fast-import has been made more\n configurable.\n@@ -207,7 +207,7 @@ Performance, Internal Implementation, Development Support etc.\n from getting added.\n \n * The core.attributesfile is intended to be set per repository, but\n- were kept track of by a single global variable in-core, which has\n+ was kept track of by a single global variable in-core, which has\n been corrected by moving it to per-repository data structure.\n \n * Use the hook API to replace ad-hoc invocation of hook scripts via\n@@ -232,8 +232,8 @@ Performance, Internal Implementation, Development Support etc.\n * Reduce dependence on the global the_hash_algo and the_repository\n variables of wt-status code path.\n \n- * The way combined list-object filter options are parsed has been\n- revamped.\n+ * The way combined list-object filter options are parsed has been\n+ revamped.\n \n * Editorconfig filename patterns were specified incorrectly, making\n many source files inside subdirectories unaffected, which has been\n@@ -272,7 +272,7 @@ Performance, Internal Implementation, Development Support etc.\n * split-index.c has been updated to not use the global the_repository\n and the_hash_algo variables.\n \n- * The unsigned integer that is used as an bitset to specify the kind\n+ * The unsigned integer that is used as a bitset to specify the kind\n of branches interpret_branch_name() function has been changed to\n use a dedicated enum type.\n \n@@ -282,7 +282,7 @@ Performance, Internal Implementation, Development Support etc.\n * Code paths that loop over another array to push each element into a\n strvec have been rewritten to use strvec_pushv() instead.\n \n- * In case homebrew breaks REG_ENHANCED again, leave a in-code comment\n+ * In case homebrew breaks REG_ENHANCED again, leave an in-code comment\n to suggest use of our replacement regex as a workaround.\n \n * MinGW build updates.\n@@ -382,7 +382,7 @@ Fixes since v2.53\n (merge f4eff7116d ps/pack-concat-wo-backfill later to maint).\n \n * \"git switch \", in an attempt to create a local branch \n- after a remote tracking branch of the same name gave an advise\n+ after a remote tracking branch of the same name gave an advice\n message to disambiguate using \"git checkout\", which has been\n updated to use \"git switch\".\n (merge 12fee11f21 jc/checkout-switch-restore later to maint).\n@@ -396,7 +396,7 @@ Fixes since v2.53\n * \"git format-patch --from=\" did not honor the command line\n option when writing out the cover letter, which has been corrected.\n \n- * Update build precedure for mergetool documentation in meson-based builds.\n+ * Update build procedure for mergetool documentation in meson-based builds.\n (merge 58e4eeeeb5 pw/meson-doc-mergetool later to maint).\n \n * An earlier attempt to optimize \"git subtree\" discarded too much\n-- \ngitgitgadget\n\n"},{"id":"541796","messageId":"01c2470fc72f9299e8a2954d99d19010a96fee2b.1776382591.git.gitgitgadget@gmail.com","threadId":"65503","inReplyTo":"pull.2092.git.1776382591.gitgitgadget@gmail.com","subject":"[PATCH 3/6] doc: fix self-referential config in sendemail.smtpSSLClientKey","fromName":"Elijah Newren via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2026-04-16T23:36:28Z","receivedAt":"2026-04-16T23:36:38Z","isPatch":true,"body":"From: Elijah Newren \n\na8215a205141 (send-email: add client certificate options, 2026-03-02)\nadded documentation for sendemail.smtpSSLClientKey that says it works\n\"in conjunction with `sendemail.smtpSSLClientKey`\" -- referring to\nitself. It appears that `sendemail.smtpSSLClientCert` was the intended\nreference; fix it.\n\nSigned-off-by: Elijah Newren \n---\n Documentation/config/sendemail.adoc | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/config/sendemail.adoc b/Documentation/config/sendemail.adoc\nindex 6560ecc5ab..1d700559b4 100644\n--- a/Documentation/config/sendemail.adoc\n+++ b/Documentation/config/sendemail.adoc\n@@ -22,7 +22,7 @@ sendemail.smtpSSLClientCert::\n sendemail.smtpSSLClientKey::\n \tPath to the client private key file that corresponds to the client\n \tcertificate. To avoid misconfiguration, this configuration must be used\n-\tin conjunction with `sendemail.smtpSSLClientKey` or the\n+\tin conjunction with `sendemail.smtpSSLClientCert` or the\n \t`--smtp-ssl-client-cert` option. If the client key is included in the\n \tclient certificate, the choice of private key depends on the format of\n \tthe certificate. Visit https://metacpan.org/pod/IO::Socket::SSL for more\n-- \ngitgitgadget\n\n"},{"id":"541795","messageId":"3af4ab215b2a02cb7e82b417fb562a1f70c67084.1776382591.git.gitgitgadget@gmail.com","threadId":"65503","inReplyTo":"pull.2092.git.1776382591.gitgitgadget@gmail.com","subject":"[PATCH 4/6] doc: fix plural agreement in pack.preferBitmapTips","fromName":"Elijah Newren via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2026-04-16T23:36:29Z","receivedAt":"2026-04-16T23:36:40Z","isPatch":true,"body":"From: Elijah Newren \n\nhierarchies -> hierarchy\n\nSigned-off-by: Elijah Newren \n---\n Documentation/config/pack.adoc | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/config/pack.adoc b/Documentation/config/pack.adoc\nindex fa997c8597..22384c2d2f 100644\n--- a/Documentation/config/pack.adoc\n+++ b/Documentation/config/pack.adoc\n@@ -161,7 +161,7 @@ pack.usePathWalk::\n \n pack.preferBitmapTips::\n \tSpecifies a ref hierarchy (e.g., \"refs/heads/\"); can be\n-\tgiven multiple times to specify more than one hierarchies.\n+\tgiven multiple times to specify more than one hierarchy.\n \tWhen selecting which commits will receive bitmaps, prefer a\n \tcommit at the tip of a reference that is contained in any of\n \tthe configured hierarchies.\n-- \ngitgitgadget\n\n"},{"id":"541797","messageId":"93e1556bd86a55501f6894f22d2c1b47fe464dba.1776382591.git.gitgitgadget@gmail.com","threadId":"65503","inReplyTo":"pull.2092.git.1776382591.gitgitgadget@gmail.com","subject":"[PATCH 5/6] doc: fix singular/plural mismatch in git-rerere","fromName":"Elijah Newren via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2026-04-16T23:36:30Z","receivedAt":"2026-04-16T23:36:41Z","isPatch":true,"body":"From: Elijah Newren \n\nconflict -> conflicts\n\nSigned-off-by: Elijah Newren \n---\n Documentation/git-rerere.adoc | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-rerere.adoc b/Documentation/git-rerere.adoc\nindex 99f967b7a4..4e6ab9a27c 100644\n--- a/Documentation/git-rerere.adoc\n+++ b/Documentation/git-rerere.adoc\n@@ -44,7 +44,7 @@ will automatically invoke this command.\n 'forget' ::\n \n Reset the conflict resolutions which rerere has recorded for the current\n-conflict in paths that match .\n+conflicts in paths that match .\n \n 'diff'::\n \n-- \ngitgitgadget\n\n"},{"id":"541798","messageId":"0b7a8230cfd89644b8cd932994362b7d2529b67c.1776382591.git.gitgitgadget@gmail.com","threadId":"65503","inReplyTo":"pull.2092.git.1776382591.gitgitgadget@gmail.com","subject":"[PATCH 2/6] CodingGuidelines: fix subject-verb agreement","fromName":"Elijah Newren via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2026-04-16T23:36:27Z","receivedAt":"2026-04-16T23:36:42Z","isPatch":true,"body":"From: Elijah Newren \n\nSigned-off-by: Elijah Newren \n---\n Documentation/CodingGuidelines | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 4992e52093..2aafcec40d 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -688,7 +688,7 @@ For C programs:\n walk_dog(dog[1]);\n \n Cases where the array is employed as a whole rather than as its unit parts,\n- the plural forms is preferable. E.g:\n+ the plural form is preferable. E.g:\n \n char *dogs[] = ...;\n walk_all_dogs(dogs);\n-- \ngitgitgadget\n\n"},{"id":"541799","messageId":"5ec9a3d20f0bda5a8c5f518b93b288d5d618406f.1776382591.git.gitgitgadget@gmail.com","threadId":"65503","inReplyTo":"pull.2092.git.1776382591.gitgitgadget@gmail.com","subject":"[PATCH 6/6] doc: fix grammar errors in submodule description","fromName":"Elijah Newren via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2026-04-16T23:36:31Z","receivedAt":"2026-04-16T23:36:42Z","isPatch":true,"body":"From: Elijah Newren \n\n6cc6d1b4c699 (Documentation: update add --force option + ignore=all\nconfig, 2026-02-06) added text describing both the ignore=none and\nignore=all behaviors. The former had minor formatting and grammatical\nerrors, while the latter was a bit garbled. I have tried to tweak the\nwording on the latter to make it read as I think was intended, and fixed\nthe minor grammatical issues with both as well.\n\nSigned-off-by: Elijah Newren \n---\n Documentation/config/submodule.adoc | 2 +-\n Documentation/gitmodules.adoc | 8 ++++----\n 2 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/config/submodule.adoc b/Documentation/config/submodule.adoc\nindex 8dacb852c7..4c424017b4 100644\n--- a/Documentation/config/submodule.adoc\n+++ b/Documentation/config/submodule.adoc\n@@ -40,7 +40,7 @@ submodule..ignore::\n \ttakes only differences between the HEAD of the submodule and the commit\n \trecorded in the superproject into account. \"untracked\" will additionally\n \tlet submodules with modified tracked files in their work tree show up.\n-\tWhen set to \"none\"(default) It also show submodules as changed if they have\n+\tWhen set to \"none\" (default) it also shows submodules as changed if they have\n \tuntracked files in their work tree.\n \tThis setting overrides any setting made in .gitmodules for this submodule,\n \tboth settings can be overridden on the command line by using the\ndiff --git a/Documentation/gitmodules.adoc b/Documentation/gitmodules.adoc\nindex 3792da96aa..fd96639806 100644\n--- a/Documentation/gitmodules.adoc\n+++ b/Documentation/gitmodules.adoc\n@@ -70,10 +70,10 @@ submodule..ignore::\n --\n \tall;; The submodule will never be considered modified (but will\n \t nonetheless show up in the output of status and commit when it has\n-\t been staged). Add `(new commits)` can be overruled using the\n-\t `git add --force `.\n-\t\tThe setting affects `status`, `update-index`, `diff` and `log`(due\n-\t\tto underlaying `diff`).\n+\t been staged). Adding a submodule with `(new commits)` can be\n+\t overridden using `git add --force `.\n+\t This setting affects `status`, `update-index`, `diff` and `log`\n+\t (due to underlying `diff`).\n \n \tdirty;; All changes to the submodule's work tree will be ignored, only\n \t committed differences between the `HEAD` of the submodule and its\n-- \ngitgitgadget\n"}]}