Re: [PATCH] doc: fix capitalization in porcelain v2 section

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 27, 2021, 20:12 UTC
Message-ID: <xmqqsfxppylh.fsf@gitster.g>
In-Reply-To: <pull.1095.git.git.1632628082841.gitgitgadget@gmail.com>

"Orgad Shaneh via GitGitGadget" <gitgitgadget@gmail.com> writes:

> Subject: Re: [PATCH] doc: fix capitalization in porcelain v2 section
> From: Orgad Shaneh <orgads@gmail.com>

Between "doc" and "porcelain v2 section", there is this level called "page" ;-) When this commit is mixed together with other commits in "git shortlog" output, it will be hard to tell that this is about fixing documentation for which command, so you must give it to your readers.

    Subject: doc: match XY placeholder in status --porcelain-v2 output

or something like that, perhaps?

Thanks.

Show 35 quoted lines

>
> The summary line had xy, while the description (and other sub-sections)
> has XY.
>
> Signed-off-by: Orgad Shaneh <orgads@gmail.com>
> ---
>     doc: fix capitalization in porcelain v2 section
>     
>     The summary line had xy, while the description (and other sub-sections)
>     has XY.
>     
>     Signed-off-by: Orgad Shaneh orgads@gmail.com
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1095%2Forgads%2Fstatus-doc-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1095/orgads/status-doc-v1
> Pull-Request: https://github.com/git/git/pull/1095
>
>  Documentation/git-status.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index 83f38e31981..c33a3d8d532 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -363,7 +363,7 @@ Field       Meaning
>  Unmerged entries have the following format; the first character is
>  a "u" to distinguish from ordinary changed entries.
>  
> -    u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
> +    u <XY> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
>  
>  ....
>  Field       Meaning
>
> base-commit: ddb1055343948e0d0bc81f8d20245f1ada6430a0