threads / patch / 62149

patch, 3 partsDocumentation/technical: fix a typo

Subject: [PATCH 1/3] Documentation/technical: fix a typo

## tl;dr

11 messages between Sep 20, 2024 and Sep 23, 2024. Diffs are folded; open one to read it.

replies: 10people: 3as markdown or json

Andrew Kreimer· Sep 20, 2024, 08:28 UTC · lore
Fix a typo in documentation.
Signed-off-by: Andrew Kreimer <algonell@gmail.com>
---
 Documentation/technical/sparse-checkout.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/technical/sparse-checkout.txt +1 −1
diff --git a/Documentation/technical/sparse-checkout.txt b/Documentation/technical/sparse-checkout.txt
index fa0d01cbda..d968659354 100644
--- a/Documentation/technical/sparse-checkout.txt
+++ b/Documentation/technical/sparse-checkout.txt
@@ -287,7 +287,7 @@ everything behaves like a dense checkout with a few exceptions (e.g. branch
 checkouts and switches write fewer things, knowing the VFS will lazily
 write the rest on an as-needed basis).
 
-Since there is no publically available VFS-related code for folks to try,
+Since there is no publicly available VFS-related code for folks to try,
 the number of folks who can test such a usecase is limited.
 
 The primary reason to note the Behavior C usecase is that as we fix things

-- 
2.39.5
Andrew Kreimer· Sep 20, 2024, 08:28 UTC · re: Andrew Kreimer · lore

[PATCH 2/3] Documentation/config: fix typos

Fix typos in documentation.
Signed-off-by: Andrew Kreimer <algonell@gmail.com>
---
 Documentation/config/extensions.txt | 2 +-
 Documentation/config/gc.txt         | 2 +-
 Documentation/config/remote.txt     | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
Show changes to 3 files +3 −3

Documentation/config/extensions.txt, Documentation/config/gc.txt, Documentation/config/remote.txt

diff --git a/Documentation/config/extensions.txt b/Documentation/config/extensions.txt
index 38dce3df35..f0a784447d 100644
--- a/Documentation/config/extensions.txt
+++ b/Documentation/config/extensions.txt
@@ -9,7 +9,7 @@ work and will produce hard-to-diagnose issues.
 
 extensions.compatObjectFormat::
 
-	Specify a compatitbility hash algorithm to use.  The acceptable values
+	Specify a compatibility hash algorithm to use.  The acceptable values
 	are `sha1` and `sha256`.  The value specified must be different from the
 	value of extensions.objectFormat.  This allows client level
 	interoperability between git repositories whose objectFormat matches
diff --git a/Documentation/config/gc.txt b/Documentation/config/gc.txt
index 1d4f9470ea..21d56db279 100644
--- a/Documentation/config/gc.txt
+++ b/Documentation/config/gc.txt
@@ -163,7 +163,7 @@ gc.repackFilterTo::
 	containing the filtered out objects. **WARNING:** The
 	specified location should be accessible, using for example the
 	Git alternates mechanism, otherwise the repo could be
-	considered corrupt by Git as it migh not be able to access the
+	considered corrupt by Git as it might not be able to access the
 	objects in that packfile. See the `--filter-to=<dir>` option
 	of linkgit:git-repack[1] and the `objects/info/alternates`
 	section of linkgit:gitrepository-layout[5].
diff --git a/Documentation/config/remote.txt b/Documentation/config/remote.txt
index 36e771556c..71d1fee835 100644
--- a/Documentation/config/remote.txt
+++ b/Documentation/config/remote.txt
@@ -50,7 +50,7 @@ remote.<name>.skipFetchAll::
 	If true, this remote will be skipped when updating
 	using linkgit:git-fetch[1], the `update` subcommand of
 	linkgit:git-remote[1], and ignored by the prefetch task
-	of `git maitenance`.
+	of `git maintenance`.
 
 remote.<name>.receivepack::
 	The default program to execute on the remote side when pushing.  See

-- 
2.39.5
Andrew Kreimer· Sep 20, 2024, 08:28 UTC · re: Andrew Kreimer · lore

[PATCH 3/3] Documentation: fix typos

Fix typos in documentation.
Signed-off-by: Andrew Kreimer <algonell@gmail.com>
---
 Documentation/BreakingChanges.txt        | 2 +-
 Documentation/CodingGuidelines           | 2 +-
 Documentation/DecisionMaking.txt         | 2 +-
 Documentation/gitformat-commit-graph.txt | 2 +-
 Documentation/gitweb.txt                 | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
Show changes to 5 files +5 −5

Documentation/BreakingChanges.txt, Documentation/CodingGuidelines, Documentation/DecisionMaking.txt, Documentation/gitformat-commit-graph.txt, Documentation/gitweb.txt

diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt
index 2b64665694..112770a9da 100644
--- a/Documentation/BreakingChanges.txt
+++ b/Documentation/BreakingChanges.txt
@@ -117,7 +117,7 @@ Cf. <20140304174806.GA11561@sigill.intra.peff.net>.
 
 * The git-pack-redundant(1) command can be used to remove redundant pack files.
   The subcommand is unusably slow and the reason why nobody reports it as a
-  performance bug is suspected to be the absense of users. We have nominated
+  performance bug is suspected to be the absence of users. We have nominated
   the command for removal and have started to emit a user-visible warning in
   c3b58472be (pack-redundant: gauge the usage before proposing its removal,
   2020-08-25) whenever the command is executed.
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 3263245b03..8a5e0b7dad 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -838,7 +838,7 @@ Markup:
  When literal and placeholders are mixed, each markup is applied for
  each sub-entity. If they are stuck, a special markup, called
  unconstrained formatting is required.
- Unconstrained formating for placeholders is __<like-this>__
+ Unconstrained formatting for placeholders is __<like-this>__
  Unconstrained formatting for literal formatting is ++like this++
    `--jobs` _<n>_
    ++--sort=++__<key>__
diff --git a/Documentation/DecisionMaking.txt b/Documentation/DecisionMaking.txt
index dbb4c1f569..b43c472ae5 100644
--- a/Documentation/DecisionMaking.txt
+++ b/Documentation/DecisionMaking.txt
@@ -54,7 +54,7 @@ implementation, for very large changes).
 
 For non-technical decisions such as community norms or processes, it is up to
 the community as a whole to implement and sustain agreed-upon changes.
-The project leadership committe (PLC) may help the implementation of
+The project leadership committee (PLC) may help the implementation of
 policy decisions.
 
 
diff --git a/Documentation/gitformat-commit-graph.txt b/Documentation/gitformat-commit-graph.txt
index 3e906e8030..14d1631234 100644
--- a/Documentation/gitformat-commit-graph.txt
+++ b/Documentation/gitformat-commit-graph.txt
@@ -122,7 +122,7 @@ All multi-byte numbers are in network byte order.
       for commits with corrected commit date offsets that cannot be
       stored within 31 bits.
     * Generation Data Overflow chunk is present only when Generation Data
-      chunk is present and atleast one corrected commit date offset cannot
+      chunk is present and at least one corrected commit date offset cannot
       be stored within 31 bits.
 
 ==== Extra Edge List (ID: {'E', 'D', 'G', 'E'}) [Optional]
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 56d24a30a3..5e2b491ec2 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -234,7 +234,7 @@ from the template during repository creation, usually installed in
 configuration variable, but the file takes precedence.
 
 category (or `gitweb.category`)::
-	Singe line category of a project, used to group projects if
+	Single line category of a project, used to group projects if
 	`$projects_list_group_categories` is enabled.  By default (file and
 	configuration variable absent), uncategorized projects are put in the
 	`$project_list_default_category` category.  You can use the

-- 
2.39.5
Eric Sunshine· Sep 20, 2024, 16:55 UTC · re: Andrew Kreimer · lore

Re: [PATCH 3/3] Documentation: fix typos

On Fri, Sep 20, 2024 at 4:29 AM Andrew Kreimer <algonell@gmail.com> wrote:
> Fix typos in documentation.
>
> Signed-off-by: Andrew Kreimer <algonell@gmail.com>
> ---
All three patches in this series look fine. Thanks.
Junio C Hamano· Sep 20, 2024, 18:17 UTC · re: Eric Sunshine · lore

Re: [PATCH 3/3] Documentation: fix typos

Eric Sunshine <sunshine@sunshineco.com> writes:
Show 7 quoted lines
> On Fri, Sep 20, 2024 at 4:29 AM Andrew Kreimer <algonell@gmail.com> wrote:
>> Fix typos in documentation.
>>
>> Signed-off-by: Andrew Kreimer <algonell@gmail.com>
>> ---
>
> All three patches in this series look fine. Thanks.
Thanks, both.
Junio C Hamano· Sep 20, 2024, 20:17 UTC · re: Andrew Kreimer · lore

Re: [PATCH 3/3] Documentation: fix typos

Andrew Kreimer <algonell@gmail.com> writes:
> Fix typos in documentation.
>
> Signed-off-by: Andrew Kreimer <algonell@gmail.com>
> ---

Some hunks have become irrelevant between 'master' and 'seen', it seems. Please separate them out and resend once these in-flight topics are merged to 'master'.

Thanks.
Show 72 quoted lines
>  Documentation/BreakingChanges.txt        | 2 +-
>  Documentation/CodingGuidelines           | 2 +-
>  Documentation/DecisionMaking.txt         | 2 +-
>  Documentation/gitformat-commit-graph.txt | 2 +-
>  Documentation/gitweb.txt                 | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt
> index 2b64665694..112770a9da 100644
> --- a/Documentation/BreakingChanges.txt
> +++ b/Documentation/BreakingChanges.txt
> @@ -117,7 +117,7 @@ Cf. <20140304174806.GA11561@sigill.intra.peff.net>.
>  
>  * The git-pack-redundant(1) command can be used to remove redundant pack files.
>    The subcommand is unusably slow and the reason why nobody reports it as a
> -  performance bug is suspected to be the absense of users. We have nominated
> +  performance bug is suspected to be the absence of users. We have nominated
>    the command for removal and have started to emit a user-visible warning in
>    c3b58472be (pack-redundant: gauge the usage before proposing its removal,
>    2020-08-25) whenever the command is executed.
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 3263245b03..8a5e0b7dad 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -838,7 +838,7 @@ Markup:
>   When literal and placeholders are mixed, each markup is applied for
>   each sub-entity. If they are stuck, a special markup, called
>   unconstrained formatting is required.
> - Unconstrained formating for placeholders is __<like-this>__
> + Unconstrained formatting for placeholders is __<like-this>__
>   Unconstrained formatting for literal formatting is ++like this++
>     `--jobs` _<n>_
>     ++--sort=++__<key>__
> diff --git a/Documentation/DecisionMaking.txt b/Documentation/DecisionMaking.txt
> index dbb4c1f569..b43c472ae5 100644
> --- a/Documentation/DecisionMaking.txt
> +++ b/Documentation/DecisionMaking.txt
> @@ -54,7 +54,7 @@ implementation, for very large changes).
>  
>  For non-technical decisions such as community norms or processes, it is up to
>  the community as a whole to implement and sustain agreed-upon changes.
> -The project leadership committe (PLC) may help the implementation of
> +The project leadership committee (PLC) may help the implementation of
>  policy decisions.
>  
>  
> diff --git a/Documentation/gitformat-commit-graph.txt b/Documentation/gitformat-commit-graph.txt
> index 3e906e8030..14d1631234 100644
> --- a/Documentation/gitformat-commit-graph.txt
> +++ b/Documentation/gitformat-commit-graph.txt
> @@ -122,7 +122,7 @@ All multi-byte numbers are in network byte order.
>        for commits with corrected commit date offsets that cannot be
>        stored within 31 bits.
>      * Generation Data Overflow chunk is present only when Generation Data
> -      chunk is present and atleast one corrected commit date offset cannot
> +      chunk is present and at least one corrected commit date offset cannot
>        be stored within 31 bits.
>  
>  ==== Extra Edge List (ID: {'E', 'D', 'G', 'E'}) [Optional]
> diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
> index 56d24a30a3..5e2b491ec2 100644
> --- a/Documentation/gitweb.txt
> +++ b/Documentation/gitweb.txt
> @@ -234,7 +234,7 @@ from the template during repository creation, usually installed in
>  configuration variable, but the file takes precedence.
>  
>  category (or `gitweb.category`)::
> -	Singe line category of a project, used to group projects if
> +	Single line category of a project, used to group projects if
>  	`$projects_list_group_categories` is enabled.  By default (file and
>  	configuration variable absent), uncategorized projects are put in the
>  	`$project_list_default_category` category.  You can use the
Andrew Kreimer· Sep 20, 2024, 21:46 UTC · re: Junio C Hamano · lore

Re: [PATCH 3/3] Documentation: fix typos

On Fri, Sep 20, 2024 at 01:17:10PM -0700, Junio C Hamano wrote:
Show 13 quoted lines
> Andrew Kreimer <algonell@gmail.com> writes:
> 
> > Fix typos in documentation.
> >
> > Signed-off-by: Andrew Kreimer <algonell@gmail.com>
> > ---
> 
> Some hunks have become irrelevant between 'master' and 'seen', it
> seems.  Please separate them out and resend once these in-flight
> topics are merged to 'master'.
> 
> Thanks.
> 
On it.
Show 73 quoted lines
> 
> >  Documentation/BreakingChanges.txt        | 2 +-
> >  Documentation/CodingGuidelines           | 2 +-
> >  Documentation/DecisionMaking.txt         | 2 +-
> >  Documentation/gitformat-commit-graph.txt | 2 +-
> >  Documentation/gitweb.txt                 | 2 +-
> >  5 files changed, 5 insertions(+), 5 deletions(-)
> >
> > diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt
> > index 2b64665694..112770a9da 100644
> > --- a/Documentation/BreakingChanges.txt
> > +++ b/Documentation/BreakingChanges.txt
> > @@ -117,7 +117,7 @@ Cf. <20140304174806.GA11561@sigill.intra.peff.net>.
> >  
> >  * The git-pack-redundant(1) command can be used to remove redundant pack files.
> >    The subcommand is unusably slow and the reason why nobody reports it as a
> > -  performance bug is suspected to be the absense of users. We have nominated
> > +  performance bug is suspected to be the absence of users. We have nominated
> >    the command for removal and have started to emit a user-visible warning in
> >    c3b58472be (pack-redundant: gauge the usage before proposing its removal,
> >    2020-08-25) whenever the command is executed.
> > diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> > index 3263245b03..8a5e0b7dad 100644
> > --- a/Documentation/CodingGuidelines
> > +++ b/Documentation/CodingGuidelines
> > @@ -838,7 +838,7 @@ Markup:
> >   When literal and placeholders are mixed, each markup is applied for
> >   each sub-entity. If they are stuck, a special markup, called
> >   unconstrained formatting is required.
> > - Unconstrained formating for placeholders is __<like-this>__
> > + Unconstrained formatting for placeholders is __<like-this>__
> >   Unconstrained formatting for literal formatting is ++like this++
> >     `--jobs` _<n>_
> >     ++--sort=++__<key>__
> > diff --git a/Documentation/DecisionMaking.txt b/Documentation/DecisionMaking.txt
> > index dbb4c1f569..b43c472ae5 100644
> > --- a/Documentation/DecisionMaking.txt
> > +++ b/Documentation/DecisionMaking.txt
> > @@ -54,7 +54,7 @@ implementation, for very large changes).
> >  
> >  For non-technical decisions such as community norms or processes, it is up to
> >  the community as a whole to implement and sustain agreed-upon changes.
> > -The project leadership committe (PLC) may help the implementation of
> > +The project leadership committee (PLC) may help the implementation of
> >  policy decisions.
> >  
> >  
> > diff --git a/Documentation/gitformat-commit-graph.txt b/Documentation/gitformat-commit-graph.txt
> > index 3e906e8030..14d1631234 100644
> > --- a/Documentation/gitformat-commit-graph.txt
> > +++ b/Documentation/gitformat-commit-graph.txt
> > @@ -122,7 +122,7 @@ All multi-byte numbers are in network byte order.
> >        for commits with corrected commit date offsets that cannot be
> >        stored within 31 bits.
> >      * Generation Data Overflow chunk is present only when Generation Data
> > -      chunk is present and atleast one corrected commit date offset cannot
> > +      chunk is present and at least one corrected commit date offset cannot
> >        be stored within 31 bits.
> >  
> >  ==== Extra Edge List (ID: {'E', 'D', 'G', 'E'}) [Optional]
> > diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
> > index 56d24a30a3..5e2b491ec2 100644
> > --- a/Documentation/gitweb.txt
> > +++ b/Documentation/gitweb.txt
> > @@ -234,7 +234,7 @@ from the template during repository creation, usually installed in
> >  configuration variable, but the file takes precedence.
> >  
> >  category (or `gitweb.category`)::
> > -	Singe line category of a project, used to group projects if
> > +	Single line category of a project, used to group projects if
> >  	`$projects_list_group_categories` is enabled.  By default (file and
> >  	configuration variable absent), uncategorized projects are put in the
> >  	`$project_list_default_category` category.  You can use the
Junio C Hamano· Sep 20, 2024, 20:12 UTC · re: Andrew Kreimer · lore

Re: [PATCH 1/3] Documentation/technical: fix a typo

Andrew Kreimer <algonell@gmail.com> writes:
Show 17 quoted lines
> Fix a typo in documentation.
>
> Signed-off-by: Andrew Kreimer <algonell@gmail.com>
> ---
>  Documentation/technical/sparse-checkout.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/technical/sparse-checkout.txt b/Documentation/technical/sparse-checkout.txt
> index fa0d01cbda..d968659354 100644
> --- a/Documentation/technical/sparse-checkout.txt
> +++ b/Documentation/technical/sparse-checkout.txt
> @@ -287,7 +287,7 @@ everything behaves like a dense checkout with a few exceptions (e.g. branch
>  checkouts and switches write fewer things, knowing the VFS will lazily
>  write the rest on an as-needed basis).
>  
> -Since there is no publically available VFS-related code for folks to try,
> +Since there is no publicly available VFS-related code for folks to try,

As a general rule, unless we are doing codewide sweep to use a single word in our glossary to refer to the same thing, or something, we should honor author's preference, when it is already written and it is not blatantly wrong.

  https://www.collinsdictionary.com/us/dictionary/english/publically

I am inclined to say that we should keep it as written, but I am not a native speaker, so please cite a source that tells what is written is blatantly wrong to help me accept this patch.

Thanks.
Andrew Kreimer· Sep 20, 2024, 21:42 UTC · re: Junio C Hamano · lore

Re: [PATCH 1/3] Documentation/technical: fix a typo

On Fri, Sep 20, 2024 at 01:12:20PM -0700, Junio C Hamano wrote:
Show 32 quoted lines
> Andrew Kreimer <algonell@gmail.com> writes:
> 
> > Fix a typo in documentation.
> >
> > Signed-off-by: Andrew Kreimer <algonell@gmail.com>
> > ---
> >  Documentation/technical/sparse-checkout.txt | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/technical/sparse-checkout.txt b/Documentation/technical/sparse-checkout.txt
> > index fa0d01cbda..d968659354 100644
> > --- a/Documentation/technical/sparse-checkout.txt
> > +++ b/Documentation/technical/sparse-checkout.txt
> > @@ -287,7 +287,7 @@ everything behaves like a dense checkout with a few exceptions (e.g. branch
> >  checkouts and switches write fewer things, knowing the VFS will lazily
> >  write the rest on an as-needed basis).
> >  
> > -Since there is no publically available VFS-related code for folks to try,
> > +Since there is no publicly available VFS-related code for folks to try,
> 
> As a general rule, unless we are doing codewide sweep to use a
> single word in our glossary to refer to the same thing, or
> something, we should honor author's preference, when it is already
> written and it is not blatantly wrong.
> 
>   https://www.collinsdictionary.com/us/dictionary/english/publically
> 
> I am inclined to say that we should keep it as written, but I am not
> a native speaker, so please cite a source that tells what is written
> is blatantly wrong to help me accept this patch.
> 
> Thanks.
My bad!
Eric Sunshine· Sep 23, 2024, 17:32 UTC · re: Junio C Hamano · lore

Re: [PATCH 1/3] Documentation/technical: fix a typo

On Fri, Sep 20, 2024 at 4:12 PM Junio C Hamano <gitster@pobox.com> wrote:
Show 14 quoted lines
> Andrew Kreimer <algonell@gmail.com> writes:
> > -Since there is no publically available VFS-related code for folks to try,
> > +Since there is no publicly available VFS-related code for folks to try,
>
> As a general rule, unless we are doing codewide sweep to use a
> single word in our glossary to refer to the same thing, or
> something, we should honor author's preference, when it is already
> written and it is not blatantly wrong.
>
>   https://www.collinsdictionary.com/us/dictionary/english/publically
>
> I am inclined to say that we should keep it as written, but I am not
> a native speaker, so please cite a source that tells what is written
> is blatantly wrong to help me accept this patch.

For what it's worth, I am a native speaker, and I was taught that the correct spelling is "publicly". Indeed, my Webster's dictionary from that era lists only "publicly"; it does not mention "publically" at all. The modern online Webster's still spells it "publicly", but at least acknowledges "publically" by saying:

    [variants] or less commonly "publically"

The modern day built-in macOS dictionary does not have an entry for "publically" and goes out of its way to loudly proclaim (in bold in a standout box) under its entry for "publicly":

    USAGE: Note that the spelling is publicly, ending with the suffix
-ly, not publically.

The word "publicly" is, of course, so frequently misspelled that it is not surprising that "publically" has been accepted into some dictionaries as a legitimate spelling, but, as one who grew up understanding the correct spelling to be "publicly", the variant spelling still makes my reading hiccup big time, so I found no problem with this patch.

Junio C Hamano· Sep 23, 2024, 18:55 UTC · re: Eric Sunshine · lore

Re: [PATCH 1/3] Documentation/technical: fix a typo

Eric Sunshine <sunshine@sunshineco.com> writes:
Show 6 quoted lines
> The word "publicly" is, of course, so frequently misspelled that it is
> not surprising that "publically" has been accepted into some
> dictionaries as a legitimate spelling, but, as one who grew up
> understanding the correct spelling to be "publicly", the variant
> spelling still makes my reading hiccup big time, so I found no problem
> with this patch.

Yup, living languages annoy old-timers more than new folks with phrases and usages that used to be ungrammatical gaining legitimacy with wider use. I see this all the time in the language I am native in, too.

Thanks for an input.  Let's queue this patch, then.

← back to recent threads