Subject: Re: [PATCH] maintenance: fix typos

From: Junio C Hamano <[email-masked]>
Date: Fri, 30 Dec 2022 12:13:16 +0900

Samanta Navarro <[email-masked]> writes:

> Subject: Re: [PATCH] maintenance: fix typos

What's "maintenance:" doing here?  This touches all over the tree,
not only the part that are related to "git maintenance" subcommand.

>  git-gui/lib/themed.tcl                   | 2 +-

This is part of a separately managed project and a patch wants to go
there first, not mixed with changes to my tree.

> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 9d5c27807a..6c7465d690 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -683,7 +683,7 @@ Writing Documentation:
> - Don't use spacing around "|" tokens when they're used to seperate the
> + Don't use spacing around "|" tokens when they're used to separate the

Good.

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 0e93aef862..229b63a454 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -182,7 +182,7 @@ included, Git breaks the cycle by prohibiting thes
> -As for the naming of this keyword, it is for forwards compatibiliy with
> +As for the naming of this keyword, it is for forwards compatibility with

Good.

> diff --git a/Documentation/fsck-msgids.txt b/Documentation/fsck-msgids.txt
> index 7af76ff99a..841ffeee38 100644
> --- a/Documentation/fsck-msgids.txt
> +++ b/Documentation/fsck-msgids.txt
> @@ -155,7 +155,7 @@
> -	(ERROR) Found a zero padded date in an author/commiter line.
> +	(ERROR) Found a zero padded date in an author/committer line.

Good.

> diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
> index 53f111bc0a..cf4a5a283e 100644
> --- a/Documentation/git-cvsserver.txt
> +++ b/Documentation/git-cvsserver.txt
> @@ -118,7 +118,7 @@ for example:
> -files, but only with the -d option (or -B if your system suports it).
> +files, but only with the -d option (or -B if your system supports it).

Good.

> diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
> index c6a79c2a0f..8ace8fb78a 100644
> --- a/Documentation/git-describe.txt
> +++ b/Documentation/git-describe.txt
> @@ -140,7 +140,7 @@ at the end.
> -The hash suffix is "-g" + an unambigous abbreviation for the tip commit
> +The hash suffix is "-g" + an unambiguous abbreviation for the tip commit

Good.

> diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
> index dfcc7da4c2..f4b6dbd2e1 100644
> --- a/Documentation/git-format-patch.txt
> +++ b/Documentation/git-format-patch.txt
> @@ -246,7 +246,7 @@ populated with placeholder text.
> -	version the new interation is compared against.
> +	version the new iteration is compared against.

Good.

> diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
> index 0240adb8ee..fa9a6b9f2c 100644
> --- a/Documentation/git-ls-tree.txt
> +++ b/Documentation/git-ls-tree.txt
> @@ -145,7 +145,7 @@ FIELD NAMES
> -into the resulting output. For each outputing line, the following
> +into the resulting output. For each outputting line, the following
>  names can be used:

The updated may use the correct spelling, but neither the original
or the updated sounds correct, neither gramatically or semantically.

 * Is "output" an intransitive verb (i.e. "The line outputs." is a
   complete sentence)?  I do not think so, but "each outputting
   line" implies so.  Like "InkJet printers output lines very
   slowly", "line" is an object of verb "output".  To make it
   readable, "for each line that is output" might work.

 * But the fields have nothing to do with "each line".  As described
   by an earlier paragraph, "--format" can take multiple fieldname
   and it is not like each fieldname substitutes to its one line.

Probably

    FIELD NAMES
    -----------

    Values from various structured fields can be interpolated into
    the resulting output.  The following can be used to name the
    fields in the `--format=<format>` option.

or something would work.

In any case, such a correction is beyond a typofix and should be
done outside the scope of this already unreadably big patch.

> diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt
> index 466a697519..b2a2e80d42 100644
> --- a/Documentation/git-mktag.txt
> +++ b/Documentation/git-mktag.txt
> @@ -33,7 +33,7 @@ from warnings to errors (so e.g. a missing "tagger" line is an error).
> -the appropriate `fsck.<msg-id>` varible:
> +the appropriate `fsck.<msg-id>` variable:

Good.

> diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
> index 68392d2a56..d6d4d42fbd 100644
> --- a/Documentation/git-sparse-checkout.txt
> +++ b/Documentation/git-sparse-checkout.txt
> @@ -263,7 +263,7 @@ patterns in non-cone mode has a number of shortcomings:
> -    it complete "/pro" to "/proc" (in the root filesytem) rather than to
> +    it complete "/pro" to "/proc" (in the root filesystem) rather than to

Good.

> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> index f4bb6114d9..06fb7f1d18 100644
> --- a/Documentation/git-stash.txt
> +++ b/Documentation/git-stash.txt
> @@ -366,7 +366,7 @@ only the commit ends-up being in the stash
> -# ... hack hack hack, finish curent changes ...
> +# ... hack hack hack, finish current changes ...

Good.

> diff --git a/Documentation/gitformat-commit-graph.txt b/Documentation/gitformat-commit-graph.txt
> index 31cad585e2..76312fa249 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.
> -      chunk is present and atleast one corrected commit date offset cannot
> +      chunk is present and at least one corrected commit date offset cannot

Good.

> diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
> index 7cee9d3689..74c35e8953 100644
> --- a/Documentation/gitweb.txt
> +++ b/Documentation/gitweb.txt
> @@ -234,7 +234,7 @@ from the template during repository creation, usually installed in
> -	Singe line category of a project, used to group projects if
> +	Single line category of a project, used to group projects if

Good.

As the patch is unreably long and boring to review for any sane
person in a single sitting, I would suggest splitting the above into
at least two patches, i.e.

 * [PATCH 1/n] doc: clarify ls-tree '--format' placeholders
 * [PATCH 2/n] Documentation: fix various typos

I haven't read the rest so I do not know what value 'n' will become,
but I would imagine fixes to typos in in-code comments may be one,
or it may need more than one.

I'll stop here, at least for now.  Thanks for working on it.