Documentation fixes

[newren]

It turns out that AI is pretty good at making small fixes to
documentation; certainly not perfect, but it provides quite good
signal. Unfortunately, there is a lot to sift through. Some points about
my strategy:

• I ignored a few categories of things like British vs. American
  spellings (though being consistent on that might be a nice change)

• I dropped many changes where I thought there wasn't an issue being
  corrected but just a switch of style being suggested (though I
  accepted a number of these types of changes before later deciding to
  drop them).

• I also started discarding lower priority changes like comma
  placement. I accepted a number of these that I thought made the
  documentation clearer, but I eventually just started dropping them
  as I had spent far more hours than I expected on this series.

• A few of the changes AI suggested were bad (it really shouldn't mess
  with protocol and RFC-like text). Definitely was useful to review.

• Occasionally I noticed an even better improvement and tweaked the
  text accordingly.

I did review every single change here, multiple times, and I have tried
to split up this series in a way to make it easier to review. In
particular I:

• dropped any changes that conflicted with anything in next or seen. I
  may resubmit some of those later.

• split it into a bunch of patches based on various grammatical rules
  being corrected

• sometimes when a single line had multiple types of changes, I split
  the fixes across multiple patches in order to group types of changes

• sometimes splitting the single-line changes seemed like too much,
  and I just combined the multiple changes to a single line with the
  first patch in the series, "wording improvements".

Let me know if there are other changes that would make this easier to
review. In a sense, though, it's already had multiple eyes looking at
this, it's just that one pair of those eyes were artificial. :-)

(Note: every patch in this series, except for the whitespace fixes
patch, are best viewed with --color-words.)

cc: Ramsay Jones ramsay@ramsayjones.plus.com
cc: Taylor Blau me@ttaylorr.com
cc: Elijah Newren newren@gmail.com

[newren]

/submit

[gitgitgadget]

Submitted as pull.1595.git.1696747527.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1595/newren/doc-fixes-v1

To fetch this version to local tag pr-1595/newren/doc-fixes-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1595/newren/doc-fixes-v1

[gitgitgadget]

On the Git mailing list, Ramsay Jones wrote (reply to this):

On 08/10/2023 07:45, Elijah Newren via GitGitGadget wrote:
[snip]
> diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt
> index 870e00f2982..42afb953e8c 100644
> --- a/Documentation/gitformat-pack.txt
> +++ b/Documentation/gitformat-pack.txt
> @@ -17,8 +17,8 @@ $GIT_DIR/objects/pack/multi-pack-index
>  DESCRIPTION
>  -----------
>  
> -The Git pack format is now Git stores most of its primary repository
> -data. Over the lietime af a repository loose objects (if any) and
> +The Git pack format is how Git stores most of its primary repository
> +data. Over the lietime of a repository loose objects (if any) and

Hmm, this tyop jumped out at me while this patch
floated past... (at least I assume it is a typo!):

  s/lietime/lifetime/

ATB,
Ramsay Jones

[gitgitgadget]

On the Git mailing list, Junio C Hamano wrote (reply to this):

Ramsay Jones <ramsay@ramsayjones.plus.com> writes:

> On 08/10/2023 07:45, Elijah Newren via GitGitGadget wrote:
> [snip]
>> diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt
>> index 870e00f2982..42afb953e8c 100644
>> --- a/Documentation/gitformat-pack.txt
>> +++ b/Documentation/gitformat-pack.txt
>> @@ -17,8 +17,8 @@ $GIT_DIR/objects/pack/multi-pack-index
>>  DESCRIPTION
>>  -----------
>>  
>> -The Git pack format is now Git stores most of its primary repository
>> -data. Over the lietime af a repository loose objects (if any) and
>> +The Git pack format is how Git stores most of its primary repository
>> +data. Over the lietime of a repository loose objects (if any) and
>
> Hmm, this tyop jumped out at me while this patch
> floated past... (at least I assume it is a typo!):
>
>   s/lietime/lifetime/
>
> ATB,
> Ramsay Jones

Thanks, will squash in.

[gitgitgadget]

On the Git mailing list, Elijah Newren wrote (reply to this):

On Sun, Oct 8, 2023 at 9:32 AM Ramsay Jones <ramsay@ramsayjones.plus.com> wrote:
>
> On 08/10/2023 07:45, Elijah Newren via GitGitGadget wrote:
> [snip]
> > diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt
> > index 870e00f2982..42afb953e8c 100644
> > --- a/Documentation/gitformat-pack.txt
> > +++ b/Documentation/gitformat-pack.txt
> > @@ -17,8 +17,8 @@ $GIT_DIR/objects/pack/multi-pack-index
> >  DESCRIPTION
> >  -----------
> >
> > -The Git pack format is now Git stores most of its primary repository
> > -data. Over the lietime af a repository loose objects (if any) and
> > +The Git pack format is how Git stores most of its primary repository
> > +data. Over the lietime of a repository loose objects (if any) and
>
> Hmm, this tyop jumped out at me while this patch
> floated past... (at least I assume it is a typo!):
>
>   s/lietime/lifetime/

Oh, that's interesting.  I wonder if the LLM did fix that, and I just
didn't notice it.  I suspect so.

Anyway, thanks for catching!  It looks like Junio manually squashed it
in, but I've also got it locally in case any other changes are pointed
out and I need to re-roll.

[gitgitgadget]

User Ramsay Jones <ramsay@ramsayjones.plus.com> has been added to the cc: list.

[gitgitgadget]

This branch is now known as en/docfixes.

[gitgitgadget]

This patch series was integrated into seen via git@14369dc.

[gitgitgadget]

This patch series was integrated into seen via git@4da4cca.

[gitgitgadget]

This patch series was integrated into seen via git@edcd745.

[gitgitgadget]

This patch series was integrated into seen via git@6fd2b83.

[gitgitgadget]

There was a status update in the "New Topics" section about the branch en/docfixes on the Git mailing list:

Documentation typo and grammo fixes.

Needs review.
source: <pull.1595.git.1696747527.gitgitgadget@gmail.com>

[gitgitgadget]

This patch series was integrated into seen via git@dab86d1.

[gitgitgadget]

This patch series was integrated into seen via git@ee282c4.

[gitgitgadget]

There was a status update in the "Cooking" section about the branch en/docfixes on the Git mailing list:

Documentation typo and grammo fixes.

Needs review.
source: <pull.1595.git.1696747527.gitgitgadget@gmail.com>

[gitgitgadget]

This patch series was integrated into seen via git@e10a891.

[gitgitgadget]

There was a status update in the "Cooking" section about the branch en/docfixes on the Git mailing list:

Documentation typo and grammo fixes.

Needs review.
source: <pull.1595.git.1696747527.gitgitgadget@gmail.com>

[gitgitgadget]

This patch series was integrated into seen via git@d1bdb94.

[gitgitgadget]

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Elijah Newren via GitGitGadget" <gitgitgadget@gmail.com> writes:

> I did review every single change here, multiple times, and I have tried to
> split up this series in a way to make it easier to review. In particular I:
> ...
> (Note: every patch in this series, except for the whitespace fixes patch,
> are best viewed with --color-words.)

I didn't think of anything clever, so ended up reading a bit by bit
over days.  I didn't find anything glaringly wrong ;-)

Let's mark it for 'next'.

Thanks.

[gitgitgadget]

This patch series was integrated into seen via git@934f21a.

[gitgitgadget]

This patch series was integrated into next via git@1e3cdeb.

[gitgitgadget]

This patch series was integrated into seen via git@e5eb92a.

[gitgitgadget]

There was a status update in the "Cooking" section about the branch en/docfixes on the Git mailing list:

Documentation typo and grammo fixes.

Will merge to 'master'.
source: <pull.1595.git.1696747527.gitgitgadget@gmail.com>

[gitgitgadget]

This patch series was integrated into seen via git@6843b23.

[gitgitgadget]

This patch series was integrated into seen via git@ac68636.

[gitgitgadget]

This patch series was integrated into seen via git@3b63330.

[gitgitgadget]

There was a status update in the "Cooking" section about the branch en/docfixes on the Git mailing list:

Documentation typo and grammo fixes.

Will merge to 'master'.
source: <pull.1595.git.1696747527.gitgitgadget@gmail.com>

[gitgitgadget]

This patch series was integrated into seen via git@d12166d.

[gitgitgadget]

This patch series was integrated into master via git@d12166d.

[gitgitgadget]

This patch series was integrated into next via git@d12166d.

[gitgitgadget]

Closed via d12166d.

[mvds00]

Hi, I encountered a minor glitch in the documentation that I would like to see fixed, could someone please /allow me on git#1629 ?