diff mbox series

doc: fix capitalization in porcelain v2 section

Message ID pull.1095.git.git.1632628082841.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit a13019916a446344e43c4ee77a748c0e2be4394c
Headers show
Series doc: fix capitalization in porcelain v2 section | expand

Commit Message

Orgad Shaneh Sept. 26, 2021, 3:48 a.m. UTC
From: Orgad Shaneh <orgads@gmail.com>

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(-)


base-commit: ddb1055343948e0d0bc81f8d20245f1ada6430a0

Comments

Junio C Hamano Sept. 27, 2021, 8:09 p.m. UTC | #1
"Orgad Shaneh via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Orgad Shaneh <orgads@gmail.com>
>
> 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>

Makes sense.  Thanks.
Junio C Hamano Sept. 27, 2021, 8:12 p.m. UTC | #2
"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.

>
> 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
Orgad Shaneh Sept. 28, 2021, 8:42 p.m. UTC | #3
On Mon, Sep 27, 2021 at 11:12 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> "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.
>
> >
> > 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

Fine with me. Should I resubmit the patch, or will you push it with
the revised subject?

-  Orgad
Junio C Hamano Sept. 28, 2021, 11:28 p.m. UTC | #4
Orgad Shaneh <orgads@gmail.com> writes:

> Fine with me. Should I resubmit the patch, or will you push it with
> the revised subject?

I have (at least for now)

 doc: fix capitalization in "git status --porcelain=v2" description

on 'seen'; if you want to tweak it further, do not hesitate to send
updates.

Thanks.
diff mbox series

Patch

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