git-status.txt: fix minor asciidoc format issue
PATCH 1/1 git-status.txt: fix minor asciidoc format issue
From: Javier Mora <[email protected]>
The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.
---
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(-)
Documentation/git-status.txt +5 -4
@@ -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
Signature · 1 line
gitgitgadget
Quoted 4 lines · cousteau via GitGitGadget
From: Javier Mora <[email protected]>
The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.
In <[email protected]>, 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]
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).
Quoted 19 lines · Junio C Hamano
Quoted 4 lines · cousteau via GitGitGadget
From: Javier Mora <[email protected]>
The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.
In <[email protected]>, 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]
Quoted 4 lines · Javier Mora
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 v2 1/1 git-status.txt: fix minor asciidoc format issue
In reply to cousteau via GitGitGadgetFrom: Javier Mora <[email protected]>
The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.
---
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(-)
Documentation/git-status.txt +3 -4
@@ -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
Signature · 1 line
gitgitgadget
Quoted 7 lines · cousteau via GitGitGadget
From: Javier Mora <[email protected]>
The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.
Signed-off-by Javier Mora <[email protected]>---
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.
Quoted 11 lines
Documentation/git-status.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)Documentation/git-status.txt +0
-0@@ -246,10 +246,9 @@ U U unmerged, both modified Submodules have more state and instead report
Documentation/git-status.txt U U unmerged, both modified · line 254
Quoted 10 lines
Documentation/git-status.txt +3
-4- 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.
Fair enough; I'll update the commit message. I just thought it still worked more or less so I left it as is.
Quoted 45 lines · Junio C Hamano
Quoted 7 lines · cousteau via GitGitGadget
From: Javier Mora <[email protected]>
The paragraph below the list of short option combinations isn't correctly formatted, making the result hard to read.
Signed-off-by Javier Mora <[email protected]>---
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.
Quoted 11 lines
Documentation/git-status.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)Documentation/git-status.txt +0
-0@@ -246,10 +246,9 @@ U U unmerged, both modified Submodules have more state and instead reportDocumentation/git-status.txt U U unmerged, both modified · line 254
Quoted 10 lines
Documentation/git-status.txt +3
-4- 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.
PATCH v3 1/1 git-status.txt: fix minor asciidoc format issue
In reply to cousteau via GitGitGadgetFrom: Javier Mora <[email protected]>
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.
---
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.
Documentation/git-status.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
Documentation/git-status.txt +3 -4
@@ -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
Signature · 1 line
gitgitgadget
Quoted 28 lines · cousteau via GitGitGadget
From: Javier Mora <[email protected]>
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 <[email protected]>---
...Documentation/git-status.txt +3
-4@@ -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.
Quoted 1 line
base-commit:
d0e8084c65cbf949038ae4cc344ac2c2efd77415
Perfect. Thanks.