Skip to content

Commit da9ca95

Browse files
peffgitster
authored andcommitted
doc/ls-files: put nested list for "-t" option into block
The description for the "-t" option contains a sub-list of all of the possible file status outputs. But because of the newline separating that list from the description paragraph, asciidoc treats the sub-list entries as a continuation of the overall options list, rather than as children of the "-t" description. We could fix it by adding a "+" before the sub-list to connect it to the rest of the "-t" text. But using a pair of "--" to delimit the block is perhaps more readable, and may have better compatibility with asciidoctor, as in 39a869b (Documentation/rev-list-options: wrap --date=<format> block with "--", 2019-03-30). The extra blank line comes from 5bc0e24 (Document ls-files -t as semi-obsolete., 2010-07-28), but the problem actually seems older than that. Before then, we did: -t:: some text... H:: cached M:: unmerged etc... but asciidoc also treats that as one big list. So this problem seems to have been around forever. Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent aeb582a commit da9ca95

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Documentation/git-ls-files.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ OPTIONS
118118
linkgit:git-status[1] `--short` or linkgit:git-diff[1]
119119
`--name-status` for more user-friendly alternatives.
120120
+
121+
--
121122
This option identifies the file status with the following tags (followed by
122123
a space) at the start of each line:
123124

@@ -128,6 +129,7 @@ a space) at the start of each line:
128129
C:: modified/changed
129130
K:: to be killed
130131
?:: other
132+
--
131133

132134
-v::
133135
Similar to `-t`, but use lowercase letters for files

0 commit comments

Comments
 (0)