diff mbox series

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

Message ID pull.1591.v2.git.1696350802820.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series [v2] git-status.txt: fix minor asciidoc format issue | expand

Commit Message

Javier Mora Oct. 3, 2023, 4:33 p.m. UTC
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(-)


base-commit: d0e8084c65cbf949038ae4cc344ac2c2efd77415

Comments

Junio C Hamano Oct. 3, 2023, 8:25 p.m. UTC | #1
"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.
Javier Mora Oct. 4, 2023, 2:09 a.m. UTC | #2
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ó:
>
> "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.
>
diff mbox series

Patch

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.