git-status.txt: fix minor asciidoc format issue

Commit Message

Javier Mora Oct. 1, 2023, 8:52 p.m. UTC

From: Javier Mora <[e-mail]>

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

Signed-off-by: Javier Mora <[e-mail]>
---
    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(-)


base-commit: bcb6cae2966cc407ca1afc77413b3ef11103c175

Comments

Junio C Hamano Oct. 1, 2023, 9:57 p.m. UTC | #1

"cousteau via GitGitGadget" <[e-mail]> writes:

> From: Javier Mora <[e-mail]>
>
> The paragraph below the list of short option combinations
> isn't correctly formatted, making the result hard to read.

In <[e-mail]>, 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/[e-mail]/

Javier Mora Oct. 1, 2023, 11:51 p.m. UTC | #2

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 (<[e-mail]>) escribió:
>
> "cousteau via GitGitGadget" <[e-mail]> writes:
>
> > From: Javier Mora <[e-mail]>
> >
> > The paragraph below the list of short option combinations
> > isn't correctly formatted, making the result hard to read.
>
> In <[e-mail]>, 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/[e-mail]/
>

Junio C Hamano Oct. 2, 2023, 6:58 p.m. UTC | #3

Javier Mora <[e-mail]> 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.

Patch

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.