Skip to contentSkip to conversation

Documentation/git-status: add missing line breaks

PATCH In review Josh Soref via GitGitGadget 2 participants 2 messages Sep 22, 2023 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation/git-status: add missing line breaks

From: Josh Soref <[email protected]>

---
Documentation/git-status: add missing line breaks

Most of the content in git help status is well formatted, as you can see here:

In the following table, these three classes are shown in separate sections, and these characters are used for X and Y fields for the first two sections that show tracked paths:

• ' ' = unmodified

• M = modified

• T = file type changed (regular file, symbolic link or submodule)

• A = added

• D = deleted

• R = renamed

• C = copied (if config option status.renames is set to "copies")

• U = updated but unmerged

X Y Meaning
-------------------------------------------------
[AMD] not updated
M [ MTD] updated in index
T [ MTD] type changed in index
A [ MTD] added to index
D deleted from index
R [ MTD] renamed in index
C [ MTD] copied in index
[MTARC] index and work tree matches
[ MTARC] M work tree changed since index
[ MTARC] T type changed in work tree since index
[ MTARC] D deleted in work tree
R renamed in work tree
C copied in work tree
-------------------------------------------------
D D unmerged, both deleted
A U unmerged, added by us
U D unmerged, deleted by them
U A unmerged, added by them
D U unmerged, deleted by us
A A unmerged, both added
U U unmerged, both modified
-------------------------------------------------
? ? untracked
! ! ignored
-------------------------------------------------

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 since modified content or untracked files in a submodule cannot be added via git add in the superproject to prepare a commit.

m and ? are applied recursively. For example if a nested submodule in a submodule contains an untracked file, this is reported as ? as well.

If -b is used the short-format status is preceded by a line

## branchname tracking info

Except for the part:

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

It appears that it wanted to be a table. With this patch, the html renders as:

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

since modified content or untracked files in a submodule cannot be added via git add in the superproject to prepare a commit.

m and ? are applied recursively. For example if a nested submodule in a submodule contains an untracked file, this is reported as ? as well.

If -b is used the short-format status is preceded by a line

## branchname tracking info

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1590%2Fjsoref%2Fgit-status-missing-line-break-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1590/jsoref/git-status-missing-line-break-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1590

 Documentation/git-status.txt | 2 ++
 1 file changed, 2 insertions(+)
Documentation/git-status.txt +2 -0
index a051b1e8f38..b27d127b5e2 100644
@@ -245,10 +245,12 @@ 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
+
 since modified content or untracked files in a submodule cannot be added
 via `git add` in the superproject to prepare a commit.
 

base-commit: bda494f4043963b9ec9a1ecd4b19b7d1cd9a0518

Signature · 1 line
gitgitgadget
#1 lore raw
Quoted 6 lines · Josh Soref via GitGitGadget

From: Josh Soref <[email protected]>

---

Documentation/git-status.txt +0 -0
@@ -245,10 +245,12 @@ U           U    unmerged, both modified
....

Documentation/git-status.txt U U unmerged, both modified · line 255

Quoted 10 lines
Documentation/git-status.txt +2 -0
 
 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
+
 since modified content or untracked files in a submodule cannot be added
 via `git add` in the superproject to prepare a commit.

Ah, good find.

Thanks, will queue.