Re: [PATCH v2 0/9] docs: interpret-trailers: reword and add examples

From: Junio C Hamano <gitster@pobox.com>
Date: May 12, 2023, 23:24 UTC
Message-ID: <xmqqv8gxm8uj.fsf@gitster.g>
In-Reply-To: <pull.1506.v2.git.git.1683839975.gitgitgadget@gmail.com>

"Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 19 quoted lines

> This series makes some small improvements to the docs for
> git-interpret-trailers. The intent is to make it easier to read for
> beginners who have never used this command before.
>
>
> Changes from v1
> ===============
>
> In order of significance:
>
>  * The phrase "commit message part" has been removed.
>  * The word "message" is always used as part of the bigger phrase "commit
>    message".
>  * Deprecation language for trailer.<token>.command has been updated to
>    minimize whitespace churn, while also tweaking the 2nd paragraph to
>    reduce duplication.
>  * The phrase "Lorem ipsum..." is always only used to stand in for the body
>    paragraph(s) of a commit message.
>  * Grammar fixes have been squashed together (01+06 previously).

Looking very good.

Unfortunately some of the updates to examples overlap moderately with what the kh/doc-interpret-trailers-updates topic wanted to do. I think I resolved them correctly, but please double check what appears in 'seen'.

As the other topic is slated to graduate in a day or two (topics usually cook for a week in 'next' before merged to 'master'), it may be a good idea to wait for more review comments and then rebase these patches on top of 'master' when that happens.

Thanks.