[PATCH] Fix duplicate word typos

[PATCH] Fix duplicate word typos

[Sven Strickroth]

Used regex to find these typos: "(?<!struct )(?<=\s)([a-z]{1,}) \1(?=\s)"

Signed-off-by: Sven Strickroth <email@cs-ware.de>
---
 Documentation/RelNotes/2.45.0.txt                      | 2 +-
 Documentation/RelNotes/2.46.0.txt                      | 2 +-
 Documentation/git-format-patch.txt                     | 2 +-
 Documentation/gitprotocol-v2.txt                       | 2 +-
 Documentation/howto/keep-canonical-history-correct.txt | 2 +-
 builtin/difftool.c                                     | 2 +-
 ci/lib.sh                                              | 2 +-
 fsmonitor.c                                            | 2 +-
 oidtree.c                                              | 2 +-
 read-cache-ll.h                                        | 2 +-
 refs/reftable-backend.c                                | 2 +-
 11 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/RelNotes/2.45.0.txt b/Documentation/RelNotes/2.45.0.txt
index fec193679f..aa0315259b 100644
--- a/Documentation/RelNotes/2.45.0.txt
+++ b/Documentation/RelNotes/2.45.0.txt
@@ -9,7 +9,7 @@ UI, Workflows & Features
    With "git init --ref-format=reftable", hopefully it would be a lot
    more efficient to manage a repository with many references.
 
- * "git checkout -p" and friends learned that that "@" is a synonym
+ * "git checkout -p" and friends learned that "@" is a synonym
    for "HEAD".
 
  * Variants of vimdiff learned to honor mergetool.<variant>.layout
diff --git a/Documentation/RelNotes/2.46.0.txt b/Documentation/RelNotes/2.46.0.txt
index b25475918a..c06a04a91b 100644
--- a/Documentation/RelNotes/2.46.0.txt
+++ b/Documentation/RelNotes/2.46.0.txt
@@ -78,7 +78,7 @@ UI, Workflows & Features
    turn on cover letters automatically (unless told never to enable
    cover letter with "--no-cover-letter" and such).
 
- * The "--heads" option of "ls-remote" and "show-ref" has been been
+ * The "--heads" option of "ls-remote" and "show-ref" has been
    deprecated; "--branches" replaces "--heads".
 
  * For over a year, setting add.interactive.useBuiltin configuration
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 8708b31593..5dc7bb4cfc 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -250,7 +250,7 @@ is not complete yet ("WIP" stands for "Work In Progress").
 +
 If the convention of the receiving community for a particular extra
 string is to have it _after_ the subject prefix, the string _<rfc>_
-can be prefixed with a dash ("`-`") to signal that the the rest of
+can be prefixed with a dash ("`-`") to signal that the rest of
 the _<rfc>_ string should be appended to the subject prefix instead,
 e.g., `--rfc='-(WIP)'` results in "PATCH (WIP)".
 
diff --git a/Documentation/gitprotocol-v2.txt b/Documentation/gitprotocol-v2.txt
index ca83b2ecc5..1652fef3ae 100644
--- a/Documentation/gitprotocol-v2.txt
+++ b/Documentation/gitprotocol-v2.txt
@@ -776,7 +776,7 @@ This would allow for optimizing the common case of servers who'd like
 to provide one "big bundle" containing only their "main" branch,
 and/or incremental updates thereof.
 +
-A client receiving such a a response MAY assume that they can skip
+A client receiving such a response MAY assume that they can skip
 retrieving the header from a bundle at the indicated URI, and thus
 save themselves and the server(s) the request(s) needed to inspect the
 headers of that bundle or bundles.
diff --git a/Documentation/howto/keep-canonical-history-correct.txt b/Documentation/howto/keep-canonical-history-correct.txt
index 5f800fd85a..e98f03275e 100644
--- a/Documentation/howto/keep-canonical-history-correct.txt
+++ b/Documentation/howto/keep-canonical-history-correct.txt
@@ -13,7 +13,7 @@ that appears to be "backwards" from what other project developers
 expect. This howto presents a suggested integration workflow for
 maintaining a central repository.
 
-Suppose that that central repository has this history:
+Suppose that the central repository has this history:
 
 ------------
     ---o---o---A
diff --git a/builtin/difftool.c b/builtin/difftool.c
index 5772e82106..ca1b089065 100644
--- a/builtin/difftool.c
+++ b/builtin/difftool.c
@@ -340,7 +340,7 @@ static void write_file_in_directory(struct strbuf *dir, size_t dir_len,
 /* Write the file contents for the left and right sides of the difftool
  * dir-diff representation for submodules and symlinks. Symlinks and submodules
  * are written as regular text files so that external diff tools can diff them
- * as text files, resulting in behavior that is analogous to to what "git diff"
+ * as text files, resulting in behavior that is analogous to what "git diff"
  * displays for symlink and submodule diffs.
  */
 static void write_standin_files(struct pair_entry *entry,
diff --git a/ci/lib.sh b/ci/lib.sh
index 74b430be23..bfa1fe370b 100755
--- a/ci/lib.sh
+++ b/ci/lib.sh
@@ -62,7 +62,7 @@ trap "end_group 'CI setup'" EXIT
 # something went wrong.
 #
 # We already enabled tracing executed commands earlier. This helps by showing
-# how # environment variables are set and and dependencies are installed.
+# how # environment variables are set and dependencies are installed.
 set -e
 
 skip_branch_tip_with_tag () {
diff --git a/fsmonitor.c b/fsmonitor.c
index 237ca59d00..309a2541cb 100644
--- a/fsmonitor.c
+++ b/fsmonitor.c
@@ -247,7 +247,7 @@ static size_t handle_using_name_hash_icase(
 	 * technically this is a tracked file or a sparse-directory.
 	 * It should not have any entries in the untracked-cache, so
 	 * we should not need to use the case-corrected spelling to
-	 * invalidate the the untracked-cache.  So we may not need to
+	 * invalidate the untracked-cache.  So we may not need to
 	 * do this.  For now, I'm going to be conservative and always
 	 * do it; we can revisit this later.
 	 */
diff --git a/oidtree.c b/oidtree.c
index 92d03b52db..151568f74f 100644
--- a/oidtree.c
+++ b/oidtree.c
@@ -47,7 +47,7 @@ void oidtree_insert(struct oidtree *ot, const struct object_id *oid)
 
 	/*
 	 * n.b. Current callers won't get us duplicates, here.  If a
-	 * future caller causes duplicates, there'll be a a small leak
+	 * future caller causes duplicates, there'll be a small leak
 	 * that won't be freed until oidtree_clear.  Currently it's not
 	 * worth maintaining a free list
 	 */
diff --git a/read-cache-ll.h b/read-cache-ll.h
index b5d11d07a8..71b49d9af4 100644
--- a/read-cache-ll.h
+++ b/read-cache-ll.h
@@ -196,7 +196,7 @@ struct index_state {
  *
  * If the variable won't be used again, use release_index() to free()
  * its resources. If it needs to be used again use discard_index(),
- * which does the same thing, but will use use index_state_init() at
+ * which does the same thing, but will use index_state_init() at
  * the end. The discard_index() will use its own "istate->repo" as the
  * "r" argument to index_state_init() in that case.
  */
diff --git a/refs/reftable-backend.c b/refs/reftable-backend.c
index 3c6107c7ce..38eb14d591 100644
--- a/refs/reftable-backend.c
+++ b/refs/reftable-backend.c
@@ -2131,7 +2131,7 @@ static int write_reflog_existence_table(struct reftable_writer *writer,
 	reftable_writer_set_limits(writer, ts, ts);
 
 	/*
-	 * The existence entry has both old and new object ID set to the the
+	 * The existence entry has both old and new object ID set to the
 	 * null object ID. Our iterators are aware of this and will not present
 	 * them to their callers.
 	 */
-- 
2.47.0.windows.1

Re: [PATCH] Fix duplicate word typos

[Kristoffer Haugsbakk]

Hi

I guess it was an intentional choice to not use an “area” in the commit
message?

I found this similar patch which used `*` as the area: abcb66c614c (*:
fix typos which duplicate a word, 2021-06-11); review here:

https://lore.kernel.org/git/CAPig+cTjjNrU9q8UPm+CRuTKq8_XNc+1z7-3F4bvetBi+NjKeQ@mail.gmail.com/

On Sat, Oct 19, 2024, at 12:37, Sven Strickroth wrote:
> Used regex to find these typos: "(?<!struct )(?<=\s)([a-z]{1,}) \1(?=\s)"

This would be more conventional:

    Used regex to find these typos:

        (?<!struct )(?<=\s)([a-z]{1,}) \1(?=\s)

Either that or code fence (MarkDown style).

>
> Signed-off-by: Sven Strickroth <email@cs-ware.de>

I can confirm that this patch only does that.  Except:

> ---
> […]
> -Suppose that that central repository has this history:
> +Suppose that the central repository has this history:

Here the doubled “that” is replaced with “the” which makes the sentence
correct.  Good.

There are also no grammatically correct “that that” constructs that have
been removed.

> Documentation/RelNotes/2.45.0.txt

I was wondering if typo fixes are done for released-released versions
(not going through RC).  But the aforementioned patch abcb66c614c does
fix a release note or two for some old versions.

-- 
Kristoffer Haugsbakk

Re: [PATCH] Fix duplicate word typos

[Patrick Steinhardt]

On Sat, Oct 19, 2024 at 12:06:54PM +0200, Kristoffer Haugsbakk wrote:
> Hi
> 
> I guess it was an intentional choice to not use an “area” in the commit
> message?
> 
> I found this similar patch which used `*` as the area: abcb66c614c (*:
> fix typos which duplicate a word, 2021-06-11); review here:
> 
> https://lore.kernel.org/git/CAPig+cTjjNrU9q8UPm+CRuTKq8_XNc+1z7-3F4bvetBi+NjKeQ@mail.gmail.com/

I think many projects also use the "global:" prefix to denote changes
all over the place. We also do this in Git, even though I should
probably say that all patches that do have that prefix are from myself
:P In any case, I don't have a strong opinion here.

Patrick

Re: [PATCH] Fix duplicate word typos

[Kristoffer Haugsbakk]

On Mon, Oct 21, 2024, at 11:47, Patrick Steinhardt wrote:
> On Sat, Oct 19, 2024 at 12:06:54PM +0200, Kristoffer Haugsbakk wrote:
>> Hi
>>
>> I guess it was an intentional choice to not use an “area” in the commit
>> message?
>>
>> I found this similar patch which used `*` as the area: abcb66c614c (*:
>> fix typos which duplicate a word, 2021-06-11); review here:
>>
>> https://lore.kernel.org/git/CAPig+cTjjNrU9q8UPm+CRuTKq8_XNc+1z7-3F4bvetBi+NjKeQ@mail.gmail.com/
>
> I think many projects also use the "global:" prefix to denote changes
> all over the place. We also do this in Git, even though I should
> probably say that all patches that do have that prefix are from myself
> :P In any case, I don't have a strong opinion here.
>
> Patrick

I forgot to mention that “treewide” is used to a decent degree.  :)

Cheers

-- 
Kristoffer Haugsbakk

[PATCH v2] global: Fix duplicate word typos

[Sven Strickroth]

Used regex to find these typos:

    (?<!struct )(?<=\s)([a-z]{1,}) \1(?=\s)

Signed-off-by: Sven Strickroth <email@cs-ware.de>
---
 Documentation/RelNotes/2.45.0.txt                      | 2 +-
 Documentation/RelNotes/2.46.0.txt                      | 2 +-
 Documentation/git-format-patch.txt                     | 2 +-
 Documentation/gitprotocol-v2.txt                       | 2 +-
 Documentation/howto/keep-canonical-history-correct.txt | 2 +-
 builtin/difftool.c                                     | 2 +-
 ci/lib.sh                                              | 2 +-
 fsmonitor.c                                            | 2 +-
 oidtree.c                                              | 2 +-
 read-cache-ll.h                                        | 2 +-
 refs/reftable-backend.c                                | 2 +-
 11 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/RelNotes/2.45.0.txt b/Documentation/RelNotes/2.45.0.txt
index fec193679f..aa0315259b 100644
--- a/Documentation/RelNotes/2.45.0.txt
+++ b/Documentation/RelNotes/2.45.0.txt
@@ -9,7 +9,7 @@ UI, Workflows & Features
    With "git init --ref-format=reftable", hopefully it would be a lot
    more efficient to manage a repository with many references.
 
- * "git checkout -p" and friends learned that that "@" is a synonym
+ * "git checkout -p" and friends learned that "@" is a synonym
    for "HEAD".
 
  * Variants of vimdiff learned to honor mergetool.<variant>.layout
diff --git a/Documentation/RelNotes/2.46.0.txt b/Documentation/RelNotes/2.46.0.txt
index b25475918a..c06a04a91b 100644
--- a/Documentation/RelNotes/2.46.0.txt
+++ b/Documentation/RelNotes/2.46.0.txt
@@ -78,7 +78,7 @@ UI, Workflows & Features
    turn on cover letters automatically (unless told never to enable
    cover letter with "--no-cover-letter" and such).
 
- * The "--heads" option of "ls-remote" and "show-ref" has been been
+ * The "--heads" option of "ls-remote" and "show-ref" has been
    deprecated; "--branches" replaces "--heads".
 
  * For over a year, setting add.interactive.useBuiltin configuration
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 8708b31593..5dc7bb4cfc 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -250,7 +250,7 @@ is not complete yet ("WIP" stands for "Work In Progress").
 +
 If the convention of the receiving community for a particular extra
 string is to have it _after_ the subject prefix, the string _<rfc>_
-can be prefixed with a dash ("`-`") to signal that the the rest of
+can be prefixed with a dash ("`-`") to signal that the rest of
 the _<rfc>_ string should be appended to the subject prefix instead,
 e.g., `--rfc='-(WIP)'` results in "PATCH (WIP)".
 
diff --git a/Documentation/gitprotocol-v2.txt b/Documentation/gitprotocol-v2.txt
index ca83b2ecc5..1652fef3ae 100644
--- a/Documentation/gitprotocol-v2.txt
+++ b/Documentation/gitprotocol-v2.txt
@@ -776,7 +776,7 @@ This would allow for optimizing the common case of servers who'd like
 to provide one "big bundle" containing only their "main" branch,
 and/or incremental updates thereof.
 +
-A client receiving such a a response MAY assume that they can skip
+A client receiving such a response MAY assume that they can skip
 retrieving the header from a bundle at the indicated URI, and thus
 save themselves and the server(s) the request(s) needed to inspect the
 headers of that bundle or bundles.
diff --git a/Documentation/howto/keep-canonical-history-correct.txt b/Documentation/howto/keep-canonical-history-correct.txt
index 5f800fd85a..e98f03275e 100644
--- a/Documentation/howto/keep-canonical-history-correct.txt
+++ b/Documentation/howto/keep-canonical-history-correct.txt
@@ -13,7 +13,7 @@ that appears to be "backwards" from what other project developers
 expect. This howto presents a suggested integration workflow for
 maintaining a central repository.
 
-Suppose that that central repository has this history:
+Suppose that the central repository has this history:
 
 ------------
     ---o---o---A
diff --git a/builtin/difftool.c b/builtin/difftool.c
index 5772e82106..ca1b089065 100644
--- a/builtin/difftool.c
+++ b/builtin/difftool.c
@@ -340,7 +340,7 @@ static void write_file_in_directory(struct strbuf *dir, size_t dir_len,
 /* Write the file contents for the left and right sides of the difftool
  * dir-diff representation for submodules and symlinks. Symlinks and submodules
  * are written as regular text files so that external diff tools can diff them
- * as text files, resulting in behavior that is analogous to to what "git diff"
+ * as text files, resulting in behavior that is analogous to what "git diff"
  * displays for symlink and submodule diffs.
  */
 static void write_standin_files(struct pair_entry *entry,
diff --git a/ci/lib.sh b/ci/lib.sh
index 74b430be23..bfa1fe370b 100755
--- a/ci/lib.sh
+++ b/ci/lib.sh
@@ -62,7 +62,7 @@ trap "end_group 'CI setup'" EXIT
 # something went wrong.
 #
 # We already enabled tracing executed commands earlier. This helps by showing
-# how # environment variables are set and and dependencies are installed.
+# how # environment variables are set and dependencies are installed.
 set -e
 
 skip_branch_tip_with_tag () {
diff --git a/fsmonitor.c b/fsmonitor.c
index 237ca59d00..309a2541cb 100644
--- a/fsmonitor.c
+++ b/fsmonitor.c
@@ -247,7 +247,7 @@ static size_t handle_using_name_hash_icase(
 	 * technically this is a tracked file or a sparse-directory.
 	 * It should not have any entries in the untracked-cache, so
 	 * we should not need to use the case-corrected spelling to
-	 * invalidate the the untracked-cache.  So we may not need to
+	 * invalidate the untracked-cache.  So we may not need to
 	 * do this.  For now, I'm going to be conservative and always
 	 * do it; we can revisit this later.
 	 */
diff --git a/oidtree.c b/oidtree.c
index 92d03b52db..151568f74f 100644
--- a/oidtree.c
+++ b/oidtree.c
@@ -47,7 +47,7 @@ void oidtree_insert(struct oidtree *ot, const struct object_id *oid)
 
 	/*
 	 * n.b. Current callers won't get us duplicates, here.  If a
-	 * future caller causes duplicates, there'll be a a small leak
+	 * future caller causes duplicates, there'll be a small leak
 	 * that won't be freed until oidtree_clear.  Currently it's not
 	 * worth maintaining a free list
 	 */
diff --git a/read-cache-ll.h b/read-cache-ll.h
index b5d11d07a8..71b49d9af4 100644
--- a/read-cache-ll.h
+++ b/read-cache-ll.h
@@ -196,7 +196,7 @@ struct index_state {
  *
  * If the variable won't be used again, use release_index() to free()
  * its resources. If it needs to be used again use discard_index(),
- * which does the same thing, but will use use index_state_init() at
+ * which does the same thing, but will use index_state_init() at
  * the end. The discard_index() will use its own "istate->repo" as the
  * "r" argument to index_state_init() in that case.
  */
diff --git a/refs/reftable-backend.c b/refs/reftable-backend.c
index 3c6107c7ce..38eb14d591 100644
--- a/refs/reftable-backend.c
+++ b/refs/reftable-backend.c
@@ -2131,7 +2131,7 @@ static int write_reflog_existence_table(struct reftable_writer *writer,
 	reftable_writer_set_limits(writer, ts, ts);
 
 	/*
-	 * The existence entry has both old and new object ID set to the the
+	 * The existence entry has both old and new object ID set to the
 	 * null object ID. Our iterators are aware of this and will not present
 	 * them to their callers.
 	 */
-- 
2.47.0.windows.1

Re: [PATCH v2] global: Fix duplicate word typos

[Patrick Steinhardt]

On Mon, Oct 21, 2024 at 05:12:26PM +0200, Sven Strickroth wrote:
> Used regex to find these typos:
> 
>     (?<!struct )(?<=\s)([a-z]{1,}) \1(?=\s)

One more nit: the first word after the area should be lower-case. So the
subject should be "foo: something" rather than "foo: Something". Other
than that the patch looks good to me. I don't really think that this is
worth a reroll, but others may disagree with that.

> diff --git a/ci/lib.sh b/ci/lib.sh
> index 74b430be23..bfa1fe370b 100755
> --- a/ci/lib.sh
> +++ b/ci/lib.sh
> @@ -62,7 +62,7 @@ trap "end_group 'CI setup'" EXIT
>  # something went wrong.
>  #
>  # We already enabled tracing executed commands earlier. This helps by showing
> -# how # environment variables are set and and dependencies are installed.
> +# how # environment variables are set and dependencies are installed.
>  set -e
>  
>  skip_branch_tip_with_tag () {

This one has a stray "#" in it, but it's perfectly fine to not fix this
as part of this commit.

Thanks!

Patrick

Re: [PATCH] Fix duplicate word typos

[Taylor Blau]

On Mon, Oct 21, 2024 at 11:57:25AM +0200, Kristoffer Haugsbakk wrote:
> On Mon, Oct 21, 2024, at 11:47, Patrick Steinhardt wrote:
> > On Sat, Oct 19, 2024 at 12:06:54PM +0200, Kristoffer Haugsbakk wrote:
> >> Hi
> >>
> >> I guess it was an intentional choice to not use an “area” in the commit
> >> message?
> >>
> >> I found this similar patch which used `*` as the area: abcb66c614c (*:
> >> fix typos which duplicate a word, 2021-06-11); review here:
> >>
> >> https://lore.kernel.org/git/CAPig+cTjjNrU9q8UPm+CRuTKq8_XNc+1z7-3F4bvetBi+NjKeQ@mail.gmail.com/
> >
> > I think many projects also use the "global:" prefix to denote changes
> > all over the place. We also do this in Git, even though I should
> > probably say that all patches that do have that prefix are from myself
> > :P In any case, I don't have a strong opinion here.
> >
> > Patrick
>
> I forgot to mention that “treewide” is used to a decent degree.  :)

Yes, I think in any case we can blame Patrick for setting the convention
here ;-).

(For what it's worth, I have occasionally used '*:' in the past, but I
don't think it matters so long as we use something to avoid 99.9% of
commits being prefixed with an area and having a few odd ones stuck
out).

Thanks,
Taylor

Re: [PATCH] Fix duplicate word typos

[Taylor Blau]

On Sat, Oct 19, 2024 at 12:06:54PM +0200, Kristoffer Haugsbakk wrote:
> I can confirm that this patch only does that.  Except:
>
> > ---
> > […]
> > -Suppose that that central repository has this history:
> > +Suppose that the central repository has this history:
>
> Here the doubled “that” is replaced with “the” which makes the sentence
> correct.  Good.
>
> There are also no grammatically correct “that that” constructs that have
> been removed.

Thanks for a careful review.

Thanks,
Taylor