git-status.txt: render tables correctly under Asciidoctor

Asciidoctor removes the indentation of each line in these tables, so the
last lines of each table have a completely broken alignment.

Similar to 379805051d ("Documentation: render revisions correctly under
Asciidoctor", 2018-05-06), use an explicit literal block to indicate
that we want to keep the leading whitespace in the tables.

Because this gives us some extra indentation, we can remove the one that
we have been carrying explicitly. That is, drop the first four spaces of
indentation on each line. With Asciidoc (8.6.10), this results in
identical rendering before and after this commit, both for git-status.1
and git-status.html.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Martin Ågren 2018-12-16 15:28:59 +01:00 committed by Junio C Hamano
parent ad1f243ad9
commit b62eb1d2f4

View file

@ -197,31 +197,33 @@ codes can be interpreted as follows:
Ignored files are not listed, unless `--ignored` option is in effect, Ignored files are not listed, unless `--ignored` option is in effect,
in which case `XY` are `!!`. in which case `XY` are `!!`.
X Y Meaning ....
------------------------------------------------- X Y Meaning
[AMD] not updated -------------------------------------------------
M [ MD] updated in index [AMD] not updated
A [ MD] added to index M [ MD] updated in index
D deleted from index A [ MD] added to index
R [ MD] renamed in index D deleted from index
C [ MD] copied in index R [ MD] renamed in index
[MARC] index and work tree matches C [ MD] copied in index
[ MARC] M work tree changed since index [MARC] index and work tree matches
[ MARC] D deleted in work tree [ MARC] M work tree changed since index
[ D] R renamed in work tree [ MARC] D deleted in work tree
[ D] C copied in work tree [ D] R renamed in work tree
------------------------------------------------- [ D] C copied in work tree
D D unmerged, both deleted -------------------------------------------------
A U unmerged, added by us D D unmerged, both deleted
U D unmerged, deleted by them A U unmerged, added by us
U A unmerged, added by them U D unmerged, deleted by them
D U unmerged, deleted by us U A unmerged, added by them
A A unmerged, both added D U unmerged, deleted by us
U U unmerged, both modified A A unmerged, both added
------------------------------------------------- U U unmerged, both modified
? ? untracked -------------------------------------------------
! ! ignored ? ? untracked
------------------------------------------------- ! ! ignored
-------------------------------------------------
....
Submodules have more state and instead report Submodules have more state and instead report
M the submodule has a different HEAD than M the submodule has a different HEAD than
@ -281,14 +283,16 @@ don't recognize.
If `--branch` is given, a series of header lines are printed with If `--branch` is given, a series of header lines are printed with
information about the current branch. information about the current branch.
Line Notes ....
------------------------------------------------------------ Line Notes
# branch.oid <commit> | (initial) Current commit. ------------------------------------------------------------
# branch.head <branch> | (detached) Current branch. # branch.oid <commit> | (initial) Current commit.
# branch.upstream <upstream_branch> If upstream is set. # branch.head <branch> | (detached) Current branch.
# branch.ab +<ahead> -<behind> If upstream is set and # branch.upstream <upstream_branch> If upstream is set.
the commit is present. # branch.ab +<ahead> -<behind> If upstream is set and
------------------------------------------------------------ the commit is present.
------------------------------------------------------------
....
### Changed Tracked Entries ### Changed Tracked Entries
@ -306,56 +310,60 @@ Renamed or copied entries have the following format:
2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath> 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
Field Meaning ....
-------------------------------------------------------- Field Meaning
<XY> A 2 character field containing the staged and --------------------------------------------------------
unstaged XY values described in the short format, <XY> A 2 character field containing the staged and
with unchanged indicated by a "." rather than unstaged XY values described in the short format,
a space. with unchanged indicated by a "." rather than
<sub> A 4 character field describing the submodule state. a space.
"N..." when the entry is not a submodule. <sub> A 4 character field describing the submodule state.
"S<c><m><u>" when the entry is a submodule. "N..." when the entry is not a submodule.
<c> is "C" if the commit changed; otherwise ".". "S<c><m><u>" when the entry is a submodule.
<m> is "M" if it has tracked changes; otherwise ".". <c> is "C" if the commit changed; otherwise ".".
<u> is "U" if there are untracked changes; otherwise ".". <m> is "M" if it has tracked changes; otherwise ".".
<mH> The octal file mode in HEAD. <u> is "U" if there are untracked changes; otherwise ".".
<mI> The octal file mode in the index. <mH> The octal file mode in HEAD.
<mW> The octal file mode in the worktree. <mI> The octal file mode in the index.
<hH> The object name in HEAD. <mW> The octal file mode in the worktree.
<hI> The object name in the index. <hH> The object name in HEAD.
<X><score> The rename or copy score (denoting the percentage <hI> The object name in the index.
of similarity between the source and target of the <X><score> The rename or copy score (denoting the percentage
move or copy). For example "R100" or "C75". of similarity between the source and target of the
<path> The pathname. In a renamed/copied entry, this move or copy). For example "R100" or "C75".
is the target path. <path> The pathname. In a renamed/copied entry, this
<sep> When the `-z` option is used, the 2 pathnames are separated is the target path.
with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09) <sep> When the `-z` option is used, the 2 pathnames are separated
byte separates them. with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
<origPath> The pathname in the commit at HEAD or in the index. byte separates them.
This is only present in a renamed/copied entry, and <origPath> The pathname in the commit at HEAD or in the index.
tells where the renamed/copied contents came from. This is only present in a renamed/copied entry, and
-------------------------------------------------------- tells where the renamed/copied contents came from.
--------------------------------------------------------
....
Unmerged entries have the following format; the first character is Unmerged entries have the following format; the first character is
a "u" to distinguish from ordinary changed entries. a "u" to distinguish from ordinary changed entries.
u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path> u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
Field Meaning ....
-------------------------------------------------------- Field Meaning
<XY> A 2 character field describing the conflict type --------------------------------------------------------
as described in the short format. <XY> A 2 character field describing the conflict type
<sub> A 4 character field describing the submodule state as described in the short format.
as described above. <sub> A 4 character field describing the submodule state
<m1> The octal file mode in stage 1. as described above.
<m2> The octal file mode in stage 2. <m1> The octal file mode in stage 1.
<m3> The octal file mode in stage 3. <m2> The octal file mode in stage 2.
<mW> The octal file mode in the worktree. <m3> The octal file mode in stage 3.
<h1> The object name in stage 1. <mW> The octal file mode in the worktree.
<h2> The object name in stage 2. <h1> The object name in stage 1.
<h3> The object name in stage 3. <h2> The object name in stage 2.
<path> The pathname. <h3> The object name in stage 3.
-------------------------------------------------------- <path> The pathname.
--------------------------------------------------------
....
### Other Items ### Other Items