docs: fix typos
PATCH 1/1 docs: fix typos
Fix some typos and grammar errors in comments and documentation files.
---
Notes:
Written mostly as an exercise on how to submit patches that depend on other topics.
$ git log --oneline --first-parent v2.54.0.. d19e9182ab (HEAD -> ta/typofixes) docs: fix typos 5a7e9cc03d Merge branch 'ta/approxidate-noon-fix' f03649d802 Merge branch 'kh/name-rev-custom-format' 023a226b4b Merge branch 'jc/neuter-sideband-fixup'
As can be seen, these topics have already graduated to master:
$ git cherry master
+ d19e9182ab097a722e32d459a9a58c8985831e3b
Documentation/config/sideband.adoc | 2 +- Documentation/git-format-rev.adoc | 2 +- date.c | 2 +- replay.h | 2 +- t/t9902-completion.sh | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-)
Documentation/config/sideband.adoc +1 -1
@@ -13,7 +13,7 @@ sideband.allowControlCharacters:: Allow control sequences that move the cursor. This is disabled by default. `erase`:: - Allow control sequences that erase charactrs. This is + Allow control sequences that erase characters. This is disabled by default. `false`:: Mask all control characters other than line feeds and
Documentation/git-format-rev.adoc +1 -1
@@ -33,7 +33,7 @@ OPTIONS The argument `rev` is also accepted. `text`;; Formats all commit object names found in freeform text. These - must the full object names, i.e. abbreviated hexidecimal object + must be full object names, i.e. abbreviated hexadecimal object names will not be interpreted. + Anything that is parsed as an object name but that is not found to be a
date.c +1 -1
@@ -1074,7 +1074,7 @@ void datestamp(struct strbuf *out)* * The tm->tm_mday field has an additional logic of using negative values * for date adjustments: -2 means yesterday and -3 the day before that, -* and so on. The idea is to deref such adjustments until we are sure +* and so on. The idea is to defer such adjustments until we are sure * there's no explicit mday specification in the approxidate string. */ static time_t update_tm (struct tm *tm,struct tm *now,time_t sec)
replay.h +1 -1
@@ -19,7 +19,7 @@ struct replay_revisions_options {/* * Starting point at which to create the new commits; must be a -* committish. References pointing at decendants of `onto` will be +* committish. References pointing at descendants of `onto` will be * updated to point to the new commits. */ const char *onto;
t/t9902-completion.sh +1 -1
@@ -2446,7 +2446,7 @@ test_expect_success FUNNYNAMES \ >repeated-quoted/2-file && >repeated-quoted/3\"file && # ... and here, too. - # Still, we shold only list the directory name only once. + # Still, we should list the directory name only once. test_path_completion repeated repeated-quoted '
base-commit: 94f057755b7941b321fd11fec1b2e3ca5313a4e0
prerequisite-patch-id: f827362e061e199150f149dd36c67664c77406bc
prerequisite-patch-id: e5b32f0b916ec86eab6631b9bd9bafd639191765
prerequisite-patch-id: 567a1832a220b2dbf095796cc8093b526d6a076c
prerequisite-patch-id: aafa4bd4ceb7836a92d28d4c89b57032f74332e9
prerequisite-patch-id: 2e073762fc9dceafcc6f16711bba425384a24305
prerequisite-patch-id: 0aa605f0acdb71aa2eb173fdf3c57713c9561fe2
prerequisite-patch-id: 5163040262c89eed4bcb04228b445d76497c9d58
prerequisite-patch-id: c06c0461bf75ed638214ce98a54bba6578941c10
prerequisite-patch-id: 571fdf3570f30fd41f6d681e99acc37df94d09a3
prerequisite-patch-id: 54e7102e880d24a6b2d22bef9aa90a3078086d4d
prerequisite-patch-id: d829fff1fcc8b6d086fcb6a40c62f835226ae32f
prerequisite-patch-id: d1d8e2f2e274565e1d7437aa5ccfe44c3f3d8355
prerequisite-patch-id: c79ebac6894b9a206f5699e9811e0348e111753d
prerequisite-patch-id: a7750d7d2ec637d906f975f27ba3d03b33a4a34f
prerequisite-patch-id: 083f554bc5e09ae54c6b545628196e11a9e90cea
Signature · 1 line
2.30.2
Quoted 1 line · Tuomas Ahola
[PATCH] docs: fix typos
The area docs isn’t correct since you are also changing comments in source files.
* could be used (as in a wildcard). Other people have used other things for “treewide” changes.
Quoted 15 lines
Fix some typos and grammar errors in comments and documentation files.
Signed-off-by Tuomas Ahola <[email protected]>---
Notes:
Written mostly as an exercise on how to submit patches that depend on other topics.$ git log --oneline --first-parent v2.54.0..
d19e9182ab(HEAD -> ta/typofixes) docs: fix typos5a7e9cc03dMerge branch 'ta/approxidate-noon-fix'f03649d802Merge branch 'kh/name-rev-custom-format'023a226b4bMerge branch 'jc/neuter-sideband-fixup'
Quoted 4 lines
As can be seen, these topics have already graduated to master:
$ git cherry master
+d19e9182ab097a722e32d459a9a58c8985831e3b
Okay, so you ran this from your branch and git-cherry(1) only found one non-merge commit that was not already in master. Makes sense.
Quoted 14 lines
Documentation/config/sideband.adoc | 2 +- Documentation/git-format-rev.adoc | 2 +- date.c | 2 +- replay.h | 2 +- t/t9902-completion.sh | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-)Documentation/config/sideband.adoc +0
-0
Documentation/config/sideband.adoc sideband.allowControlCharacters:: · line 16
Quoted 5 lines
Documentation/config/sideband.adoc +1
-1@@ -13,7 +13,7 @@ sideband.allowControlCharacters:: Allow control sequences that move the cursor. This is disabled by default. `erase`:: - Allow control sequences that erase charactrs. This is + Allow control sequences that erase characters. This is
Correction is correct.
Quoted 9 lines
Documentation/config/sideband.adoc +0
-0disabled by default. `false`:: Mask all control characters other than line feeds andDocumentation/git-format-rev.adoc +0
-0
Documentation/git-format-rev.adoc OPTIONS · line 36
Quoted 5 lines
Documentation/git-format-rev.adoc +1
-1@@ -33,7 +33,7 @@ OPTIONS The argument `rev` is also accepted. `text`;; Formats all commit object names found in freeform text. These - must the full object names, i.e. abbreviated hexidecimal object + must be full object names, i.e. abbreviated hexadecimal object
Correct. It should have been “hexadecimal”.
This also corrects a bewildering “the” where “be” should have been.
date.c void datestamp(struct strbuf *out) · line 1077
Quoted 13 lines
Documentation/git-format-rev.adoc +0
-0names will not be interpreted. + Anything that is parsed as an object name but that is not found to be adate.c +1
-1@@ -1074,7 +1074,7 @@ void datestamp(struct strbuf *out)* * The tm->tm_mday field has an additional logic of using negative values * for date adjustments: -2 means yesterday and -3 the day before that, -* and so on. The idea is to deref such adjustments until we are sure +* and so on. The idea is to defer such adjustments until we are sure
“deref” could have been “dereference” but this must indeed mean “defer”. We are putting off a decision until later.
replay.h struct replay_revisions_options { · line 22
Quoted 13 lines
date.c +0
-0* there's no explicit mday specification in the approxidate string. */ static time_t update_tm (struct tm *tm,struct tm *now,time_t sec)replay.h +1
-1@@ -19,7 +19,7 @@ struct replay_revisions_options {/* * Starting point at which to create the new commits; must be a -* committish. References pointing at decendants of `onto` will be +* committish. References pointing at descendants of `onto` will be
Correct.
t/t9902-completion.sh test_expect_success FUNNYNAMES \ · line 2449
Quoted 13 lines
replay.h +0
-0* updated to point to the new commits. */ const char *onto;t/t9902-completion.sh +1
-1@@ -2446,7 +2446,7 @@ test_expect_success FUNNYNAMES \ >repeated-quoted/2-file && >repeated-quoted/3\"file && # ... and here, too. - # Still, we shold only list the directory name only once. + # Still, we should list the directory name only once.
Correct, that’s a “shold” typo.
Second time looking it over I see that you also drop the doubled “only”.
Quoted 4 lines
t/t9902-completion.sh +0
-0test_path_completion repeated repeated-quoted '
Quoted 16 lines
base-commit:
94f057755b7941b321fd11fec1b2e3ca5313a4e0
prerequisite-patch-id:f827362e061e199150f149dd36c67664c77406bc
prerequisite-patch-id:e5b32f0b916ec86eab6631b9bd9bafd639191765
prerequisite-patch-id:567a1832a220b2dbf095796cc8093b526d6a076c
prerequisite-patch-id:aafa4bd4ceb7836a92d28d4c89b57032f74332e9
prerequisite-patch-id:2e073762fc9dceafcc6f16711bba425384a24305
prerequisite-patch-id:0aa605f0acdb71aa2eb173fdf3c57713c9561fe2
prerequisite-patch-id:5163040262c89eed4bcb04228b445d76497c9d58
prerequisite-patch-id:c06c0461bf75ed638214ce98a54bba6578941c10
prerequisite-patch-id:571fdf3570f30fd41f6d681e99acc37df94d09a3
prerequisite-patch-id:54e7102e880d24a6b2d22bef9aa90a3078086d4d
prerequisite-patch-id:d829fff1fcc8b6d086fcb6a40c62f835226ae32f
prerequisite-patch-id:d1d8e2f2e274565e1d7437aa5ccfe44c3f3d8355
prerequisite-patch-id:c79ebac6894b9a206f5699e9811e0348e111753d
prerequisite-patch-id:a7750d7d2ec637d906f975f27ba3d03b33a4a34f
prerequisite-patch-id:083f554bc5e09ae54c6b545628196e11a9e90cea
Okay, these must be all the non-merge commits from the topics you merged in.
Quoted 2 lines
--
2.30.2
Quoted 9 lines · Kristoffer Haugsbakk
Quoted 1 line · Tuomas Ahola
[PATCH] docs: fix typos
The area
docsisn’t correct since you are also changing comments in source files.
*could be used (as in a wildcard). Other people have used other things for “treewide” changes.
Hmm, I took that from the other typofix patches we have currently in seen.
Quoted 8 lines
Quoted 4 lines
* The
tm->tm_mdayfield has an additional logic of using negative values
* for date adjustments: -2 means yesterday and -3 the day before that,
- * and so on. The idea is to deref such adjustments until we are sure
+ * and so on. The idea is to defer such adjustments until we are sure“deref” could have been “dereference” but this must indeed mean “defer”. We are putting off a decision until later.
Yes, that was my own typo. I always meant "defer".
Quoted 10 lines
Quoted 6 lines
base-commit:
94f057755b7941b321fd11fec1b2e3ca5313a4e0
prerequisite-patch-id:f827362e061e199150f149dd36c67664c77406bc
prerequisite-patch-id:e5b32f0b916ec86eab6631b9bd9bafd639191765
[...]
prerequisite-patch-id:083f554bc5e09ae54c6b545628196e11a9e90ceaOkay, these must be all the non-merge commits from the topics you merged in.
That's true. Quite a list though.
Thanks for review!
Quoted 5 lines · Tuomas Ahola
Quoted 3 lines · Kristoffer Haugsbakk
Quoted 1 line · Tuomas Ahola
[PATCH] docs: fix typos
Quoted 8 lines
Quoted 6 lines
The area
docsisn´t correct since you are also changing comments in source files.
*could be used (as in a wildcard). Other people have used other things for "treewide" changes.Hmm, I took that from the other typofix patches we have currently in
seen.
Hi all,
Yup, my patch 8570d9ba31 (Merge branch 'wy/docs-typofixes' into seen, 2026-06-04) used "docs" as the scope of the commit message.
I thought for a while what would be the preferred scope for a typofixes commit that touches a quite wide range of the tree. And I didn't know we could use "*".
On the one hand, I would rather let the typofix thing be simple and easy in one commit, since the actual changes were sort of logically unified. On the other hand, splitting them apart makes it easier to name the scope of each commit, while it would make much "meaningless" noise. So I was torn at that time.
"Luckily", Junio didn't say something about that, and my topic is waiting for more comments. So it just happens when I am struggling with re-roll it or not, I saw this thread. Therefore, could you please also raise it again in my topic in order to give it a final decision? (Or start a new thread as my patch is actually in Andrew's thread, really sorry Andrew)
Message-ID of my previous patch:
<7b502e20e9495cd4720496bd6738a1fbeb453410.1780041658.git.wy@wyuan.org>
Thanks!
Quoted 4 lines · Tuomas Ahola
Fix some typos and grammar errors in comments and documentation files.
Signed-off-by Tuomas Ahola <[email protected]>---
Thanks, all changes make sense. Will queue.
Quoted 8 lines · Tuomas Ahola
Fix some typos and grammar errors in comments and documentation files.
Signed-off-by Tuomas Ahola <[email protected]>---
Notes:
Written mostly as an exercise on how to submit patches that depend on other topics.
I’ve been thinking of how to handle typos for a few days now. ;) The following does not apply to this submission since the maintainer said that he will apply it.
Anyway, it struck me that you might sometimes want to apply the typofix on top of the original branch *if* the branch is scheduled to be merged to more than just master.
So e.g. this does *not* apply to topic kh/name-rev-custom-format since that topic is not scheduled for a maintenance branch (maint). But:
Quoted 4 lines
$ git log --oneline --first-parent v2.54.0..
d19e9182ab (HEAD -> ta/typofixes) docs: fix typos
5a7e9cc03d Merge branch 'ta/approxidate-noon-fix'Your topic is. See RelNotes:
(merge b809304101 ta/approxidate-noon-fix later to maint).
So it might make sense in such cases to post a patch to be applied on top of the topic.
Just a thought for later.
Quoted 8 lines
f03649d802Merge branch 'kh/name-rev-custom-format'023a226b4bMerge branch 'jc/neuter-sideband-fixup'As can be seen, these topics have already graduated to master:
$ git cherry master
+d19e9182ab097a722e32d459a9a58c8985831e3b
[snip]