threads / patch / 60288

patchgit-status.txt: fix minor asciidoc format issue

Subject: [PATCH] git-status.txt: fix minor asciidoc format issue

## tl;dr

9 messages between Oct 1, 2023 and Oct 4, 2023. Diffs are folded; open one to read it.

replies: 8people: 3as markdown or json

cousteau via GitGitGadget· Oct 1, 2023, 20:52 UTC · lore
From: Javier Mora <cousteaulecommandant@gmail.com>

The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.

Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
---
    git-status.txt: minor asciidoc format correction
    
    The paragraph below the list of short option combinations was hard to
    read; turns out it wasn't correctly formatted in asciidoc.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1591%2Fcousteaulecommandant%2Fman-git-status-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1591/cousteaulecommandant/man-git-status-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1591
 Documentation/git-status.txt | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
Show changes to Documentation/git-status.txt +5 −4
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index a051b1e8f38..48f46eb2047 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -245,10 +245,11 @@ U           U    unmerged, both modified
 ....
 
 Submodules have more state and instead report
-		M    the submodule has a different HEAD than
-		     recorded in the index
-		m    the submodule has modified content
-		?    the submodule has untracked files
+
+* 'M' = the submodule has a different HEAD than recorded in the index
+* 'm' = the submodule has modified content
+* '?' = the submodule has untracked files
+
 since modified content or untracked files in a submodule cannot be added
 via `git add` in the superproject to prepare a commit.
 

base-commit: bcb6cae2966cc407ca1afc77413b3ef11103c175

-- 
gitgitgadget
Junio C Hamano· Oct 1, 2023, 21:57 UTC · re: cousteau via GitGitGadget · lore

Re: [PATCH] git-status.txt: fix minor asciidoc format issue

"cousteau via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: Javier Mora <cousteaulecommandant@gmail.com>
>
> The paragraph below the list of short option combinations
> isn't correctly formatted, making the result hard to read.

In <pull.1590.git.1695392082207.gitgitgadget@gmail.com>, Josh fixed this issue a bit differently but in the same spirit, and the fix in 38a15f47 (Documentation/git-status: add missing line breaks, 2023-09-22) is about to hit the 'master' branch.

Thanks.
[Reference]
* https://lore.kernel.org/git/pull.1590.git.1695392082207.gitgitgadget@gmail.com/
Javier Mora· Oct 1, 2023, 23:51 UTC · re: Junio C Hamano · lore

Re: [PATCH] git-status.txt: fix minor asciidoc format issue

Yeah, I saw that right after I submitted my patch :( Only problem is that that patch doesn't use the same formatting as the rest of the document (uses a code block / preformatted text instead of a list as other options in the document do) so my version of the patch is just a minor cosmetic improvement now. (In any case, the result is quite similar in the plain text manpage version; the change is more noticeable in the HTML version though.)

If you're still interested in the "format as a list" issue and it makes things easier to you, I can submit a merge of both commits (fixing the merge conflict).

El dom, 1 oct 2023 a las 22:57, Junio C Hamano (<gitster@pobox.com>) escribió:
Show 19 quoted lines
>
> "cousteau via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
> > From: Javier Mora <cousteaulecommandant@gmail.com>
> >
> > The paragraph below the list of short option combinations
> > isn't correctly formatted, making the result hard to read.
>
> In <pull.1590.git.1695392082207.gitgitgadget@gmail.com>, Josh fixed
> this issue a bit differently but in the same spirit, and the fix in
> 38a15f47 (Documentation/git-status: add missing line breaks,
> 2023-09-22) is about to hit the 'master' branch.
>
> Thanks.
>
> [Reference]
>
> * https://lore.kernel.org/git/pull.1590.git.1695392082207.gitgitgadget@gmail.com/
>
Junio C Hamano· Oct 2, 2023, 18:58 UTC · re: Javier Mora · lore

Re: [PATCH] git-status.txt: fix minor asciidoc format issue

Javier Mora <cousteaulecommandant@gmail.com> writes:
> Only problem is that that patch doesn't use the same formatting as the
> rest of the document (uses a code block / preformatted text instead of
> a list as other options in the document do) so my version of the patch
> is just a minor cosmetic improvement now.

Either one is a minor cosmetic improvement ;-) I do agree with you that it is more appropriate to use the enumeration. A patch on top of 'master' (which now has Josh's fix) would be very much welcome.

Thanks.
cousteau via GitGitGadget· Oct 3, 2023, 16:33 UTC · re: cousteau via GitGitGadget · lore

[PATCH v2] git-status.txt: fix minor asciidoc format issue

From: Javier Mora <cousteaulecommandant@gmail.com>

The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.

Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
---
    git-status.txt: minor asciidoc format correction
    
    The paragraph below the list of short option combinations was hard to
    read; turns out it wasn't correctly formatted in asciidoc.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1591%2Fcousteaulecommandant%2Fman-git-status-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1591/cousteaulecommandant/man-git-status-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1591
Range-diff vs v1:
 1:  b3c97ca9e0f ! 1:  811885a275f git-status.txt: fix minor asciidoc format issue
     @@ Commit message
      
       ## Documentation/git-status.txt ##
      @@ Documentation/git-status.txt: U           U    unmerged, both modified
     - ....
       
       Submodules have more state and instead report
     + 
      -		M    the submodule has a different HEAD than
      -		     recorded in the index
      -		m    the submodule has modified content
      -		?    the submodule has untracked files
     -+
      +* 'M' = the submodule has a different HEAD than recorded in the index
      +* 'm' = the submodule has modified content
      +* '?' = the submodule has untracked files
     -+
     + 
       since modified content or untracked files in a submodule cannot be added
       via `git add` in the superproject to prepare a commit.
     - 
 Documentation/git-status.txt | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
Show changes to Documentation/git-status.txt +3 −4
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index b27d127b5e2..48f46eb2047 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -246,10 +246,9 @@ U           U    unmerged, both modified
 
 Submodules have more state and instead report
 
-		M    the submodule has a different HEAD than
-		     recorded in the index
-		m    the submodule has modified content
-		?    the submodule has untracked files
+* 'M' = the submodule has a different HEAD than recorded in the index
+* 'm' = the submodule has modified content
+* '?' = the submodule has untracked files
 
 since modified content or untracked files in a submodule cannot be added
 via `git add` in the superproject to prepare a commit.

base-commit: d0e8084c65cbf949038ae4cc344ac2c2efd77415

-- 
gitgitgadget
Junio C Hamano· Oct 3, 2023, 20:25 UTC · re: cousteau via GitGitGadget · lore

Re: [PATCH v2] git-status.txt: fix minor asciidoc format issue

"cousteau via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 7 quoted lines
> From: Javier Mora <cousteaulecommandant@gmail.com>
>
> The paragraph below the list of short option combinations
> isn't correctly formatted, making the result hard to read.
>
> Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
> ---

The above probably no longer describes the situation the patch intends to correct, I suspect. It used to be near-impossible hard to read, but at least with them indented they are legible.

	The additional states for submodules are typeset differently
	from how the states for paths for normal blobs are listed as
	enumeration.  Format them in the same way for consistency.
or something like that, perhaps.
Show 21 quoted lines
>  Documentation/git-status.txt | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index b27d127b5e2..48f46eb2047 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -246,10 +246,9 @@ U           U    unmerged, both modified
>  
>  Submodules have more state and instead report
>  
> -		M    the submodule has a different HEAD than
> -		     recorded in the index
> -		m    the submodule has modified content
> -		?    the submodule has untracked files
> +* 'M' = the submodule has a different HEAD than recorded in the index
> +* 'm' = the submodule has modified content
> +* '?' = the submodule has untracked files
>  
>  since modified content or untracked files in a submodule cannot be added
>  via `git add` in the superproject to prepare a commit.
Thanks for making this part of the documentation better.
Javier Mora· Oct 4, 2023, 02:09 UTC · re: Junio C Hamano · lore

Re: [PATCH v2] git-status.txt: fix minor asciidoc format issue

Fair enough; I'll update the commit message. I just thought it still worked more or less so I left it as is.

El mar, 3 oct 2023 a las 21:25, Junio C Hamano (<gitster@pobox.com>) escribió:
Show 45 quoted lines
>
> "cousteau via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
> > From: Javier Mora <cousteaulecommandant@gmail.com>
> >
> > The paragraph below the list of short option combinations
> > isn't correctly formatted, making the result hard to read.
> >
> > Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
> > ---
>
> The above probably no longer describes the situation the patch
> intends to correct, I suspect.  It used to be near-impossible hard
> to read, but at least with them indented they are legible.
>
>         The additional states for submodules are typeset differently
>         from how the states for paths for normal blobs are listed as
>         enumeration.  Format them in the same way for consistency.
>
> or something like that, perhaps.
>
> >  Documentation/git-status.txt | 7 +++----
> >  1 file changed, 3 insertions(+), 4 deletions(-)
> >
> > diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> > index b27d127b5e2..48f46eb2047 100644
> > --- a/Documentation/git-status.txt
> > +++ b/Documentation/git-status.txt
> > @@ -246,10 +246,9 @@ U           U    unmerged, both modified
> >
> >  Submodules have more state and instead report
> >
> > -             M    the submodule has a different HEAD than
> > -                  recorded in the index
> > -             m    the submodule has modified content
> > -             ?    the submodule has untracked files
> > +* 'M' = the submodule has a different HEAD than recorded in the index
> > +* 'm' = the submodule has modified content
> > +* '?' = the submodule has untracked files
> >
> >  since modified content or untracked files in a submodule cannot be added
> >  via `git add` in the superproject to prepare a commit.
>
> Thanks for making this part of the documentation better.
>
cousteau via GitGitGadget· Oct 4, 2023, 02:22 UTC · re: cousteau via GitGitGadget · lore

[PATCH v3] git-status.txt: fix minor asciidoc format issue

From: Javier Mora <cousteaulecommandant@gmail.com>

The list of additional XY values for submodules in short format isn't formatted consistently with the rest of the document. Format as list for consistency.

Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
---
    git-status.txt: minor asciidoc format correction
    
    The paragraph below the list of short option combinations was hard to
    read; turns out it wasn't correctly formatted in asciidoc.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1591%2Fcousteaulecommandant%2Fman-git-status-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1591/cousteaulecommandant/man-git-status-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1591
Range-diff vs v2:
 1:  811885a275f ! 1:  819499eb4c8 git-status.txt: fix minor asciidoc format issue
     @@ Metadata
       ## Commit message ##
          git-status.txt: fix minor asciidoc format issue
      
     -    The paragraph below the list of short option combinations
     -    isn't correctly formatted, making the result hard to read.
     +    The list of additional XY values for submodules in short format
     +    isn't formatted consistently with the rest of the document.
     +    Format as list for consistency.
      
          Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
      
 Documentation/git-status.txt | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
Show changes to Documentation/git-status.txt +3 −4
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index b27d127b5e2..48f46eb2047 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -246,10 +246,9 @@ U           U    unmerged, both modified
 
 Submodules have more state and instead report
 
-		M    the submodule has a different HEAD than
-		     recorded in the index
-		m    the submodule has modified content
-		?    the submodule has untracked files
+* 'M' = the submodule has a different HEAD than recorded in the index
+* 'm' = the submodule has modified content
+* '?' = the submodule has untracked files
 
 since modified content or untracked files in a submodule cannot be added
 via `git add` in the superproject to prepare a commit.

base-commit: d0e8084c65cbf949038ae4cc344ac2c2efd77415

-- 
gitgitgadget
Junio C Hamano· Oct 4, 2023, 16:56 UTC · re: cousteau via GitGitGadget · lore

Re: [PATCH v3] git-status.txt: fix minor asciidoc format issue

"cousteau via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 29 quoted lines
> From: Javier Mora <cousteaulecommandant@gmail.com>
>
> The list of additional XY values for submodules in short format
> isn't formatted consistently with the rest of the document.
> Format as list for consistency.
>
> Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
> ---
> ...
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index b27d127b5e2..48f46eb2047 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -246,10 +246,9 @@ U           U    unmerged, both modified
>  
>  Submodules have more state and instead report
>  
> -		M    the submodule has a different HEAD than
> -		     recorded in the index
> -		m    the submodule has modified content
> -		?    the submodule has untracked files
> +* 'M' = the submodule has a different HEAD than recorded in the index
> +* 'm' = the submodule has modified content
> +* '?' = the submodule has untracked files
>  
>  since modified content or untracked files in a submodule cannot be added
>  via `git add` in the superproject to prepare a commit.
>
> base-commit: d0e8084c65cbf949038ae4cc344ac2c2efd77415
Perfect.  Thanks.

← back to recent threads