Documentation: wrap blocks with "--"
The documentation for each of these options contains a list. After the list, AsciiDoc interprets the continuation as a continuation of the *list*, not as a continution of the larger block. As a result, we get too much indentation. Wrap the entire blocks in "--" to fix this. With Asciidoctor, this commit is a no-op, and the two programs now render these identically. These two files share the same problem and indeed, they both document `--untracked-files` in quite similar ways. I haven't checked to what extent that is intentional or warranted, and to what extent they have simply drifted apart. I consider such an investigation and possible cleanup as out of scope for this commit and this patch series. Signed-off-by: Martin Ågren <martin.agren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Martin Ågren committed
Sep 7, 2019 at 16:12 UTC
2017956a192d0dbcecbba604a76082ff8bbd3e3d
2 files changed
+16
-10
Documentation/git-commit.txt
+5
-3
@@ -282,18 +282,20 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
282
--untracked-files[=<mode>]::
283
Show untracked files.
284
+
285
+--
286
The mode parameter is optional (defaults to 'all'), and is used to
287
specify the handling of untracked files; when -u is not used, the
288
default is 'normal', i.e. show untracked files and directories.
288
-+
289
+
290
The possible options are:
290
-+
291
+
292
- 'no' - Show no untracked files
293
- 'normal' - Shows untracked files and directories
294
- 'all' - Also shows individual files in untracked directories.
294
-+
295
+
296
The default can be changed using the status.showUntrackedFiles
297
configuration variable documented in linkgit:git-config[1].
298
+--
299
300
-v::
301
--verbose::
Documentation/git-status.txt
+11
-7
@@ -59,16 +59,17 @@ This is optional and defaults to the original version 'v1' format.
59
--untracked-files[=<mode>]::
60
Show untracked files.
61
+
62
+--
63
The mode parameter is used to specify the handling of untracked files.
64
It is optional: it defaults to 'all', and if specified, it must be
65
stuck to the option (e.g. `-uno`, but not `-u no`).
65
-+
66
+
67
The possible options are:
67
-+
68
+
69
- 'no' - Show no untracked files.
70
- 'normal' - Shows untracked files and directories.
71
- 'all' - Also shows individual files in untracked directories.
71
-+
72
+
73
When `-u` option is not used, untracked files and directories are
74
shown (i.e. the same as specifying `normal`), to help you avoid
75
forgetting to add newly created files. Because it takes extra work
@@ -78,9 +79,10 @@ Consider enabling untracked cache and split index if supported (see
79
`git update-index --untracked-cache` and `git update-index
80
--split-index`), Otherwise you can use `no` to have `git status`
81
return more quickly without showing untracked files.
81
-+
82
+
83
The default can be changed using the status.showUntrackedFiles
84
configuration variable documented in linkgit:git-config[1].
85
+--
86
87
--ignore-submodules[=<when>]::
88
Ignore changes to submodules when looking for changes. <when> can be
@@ -100,11 +102,12 @@ configuration variable documented in linkgit:git-config[1].
102
--ignored[=<mode>]::
103
Show ignored files as well.
104
+
105
+--
106
The mode parameter is used to specify the handling of ignored files.
107
It is optional: it defaults to 'traditional'.
105
-+
108
+
109
The possible options are:
107
-+
110
+
111
- 'traditional' - Shows ignored files and directories, unless
112
--untracked-files=all is specified, in which case
113
individual files in ignored directories are
@@ -112,12 +115,13 @@ The possible options are:
115
- 'no' - Show no ignored files.
116
- 'matching' - Shows ignored files and directories matching an
117
ignore pattern.
115
-+
118
+
119
When 'matching' mode is specified, paths that explicitly match an
120
ignored pattern are shown. If a directory matches an ignore pattern,
121
then it is shown, but not paths contained in the ignored directory. If
122
a directory does not match an ignore pattern, but all contents are
123
ignored, then the directory is not shown, but all contents are shown.
124
+--
125
126
-z::
127
Terminate entries with NUL, instead of LF. This implies