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>
This commit is contained in:
parent
745f681289
commit
2017956a19
@ -282,18 +282,20 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
|
|||||||
--untracked-files[=<mode>]::
|
--untracked-files[=<mode>]::
|
||||||
Show untracked files.
|
Show untracked files.
|
||||||
+
|
+
|
||||||
|
--
|
||||||
The mode parameter is optional (defaults to 'all'), and is used to
|
The mode parameter is optional (defaults to 'all'), and is used to
|
||||||
specify the handling of untracked files; when -u is not used, the
|
specify the handling of untracked files; when -u is not used, the
|
||||||
default is 'normal', i.e. show untracked files and directories.
|
default is 'normal', i.e. show untracked files and directories.
|
||||||
+
|
|
||||||
The possible options are:
|
The possible options are:
|
||||||
+
|
|
||||||
- 'no' - Show no untracked files
|
- 'no' - Show no untracked files
|
||||||
- 'normal' - Shows untracked files and directories
|
- 'normal' - Shows untracked files and directories
|
||||||
- 'all' - Also shows individual files in untracked directories.
|
- 'all' - Also shows individual files in untracked directories.
|
||||||
+
|
|
||||||
The default can be changed using the status.showUntrackedFiles
|
The default can be changed using the status.showUntrackedFiles
|
||||||
configuration variable documented in linkgit:git-config[1].
|
configuration variable documented in linkgit:git-config[1].
|
||||||
|
--
|
||||||
|
|
||||||
-v::
|
-v::
|
||||||
--verbose::
|
--verbose::
|
||||||
|
@ -59,16 +59,17 @@ This is optional and defaults to the original version 'v1' format.
|
|||||||
--untracked-files[=<mode>]::
|
--untracked-files[=<mode>]::
|
||||||
Show untracked files.
|
Show untracked files.
|
||||||
+
|
+
|
||||||
|
--
|
||||||
The mode parameter is used to specify the handling of untracked files.
|
The mode parameter is used to specify the handling of untracked files.
|
||||||
It is optional: it defaults to 'all', and if specified, it must be
|
It is optional: it defaults to 'all', and if specified, it must be
|
||||||
stuck to the option (e.g. `-uno`, but not `-u no`).
|
stuck to the option (e.g. `-uno`, but not `-u no`).
|
||||||
+
|
|
||||||
The possible options are:
|
The possible options are:
|
||||||
+
|
|
||||||
- 'no' - Show no untracked files.
|
- 'no' - Show no untracked files.
|
||||||
- 'normal' - Shows untracked files and directories.
|
- 'normal' - Shows untracked files and directories.
|
||||||
- 'all' - Also shows individual files in untracked directories.
|
- 'all' - Also shows individual files in untracked directories.
|
||||||
+
|
|
||||||
When `-u` option is not used, untracked files and directories are
|
When `-u` option is not used, untracked files and directories are
|
||||||
shown (i.e. the same as specifying `normal`), to help you avoid
|
shown (i.e. the same as specifying `normal`), to help you avoid
|
||||||
forgetting to add newly created files. Because it takes extra work
|
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
|
|||||||
`git update-index --untracked-cache` and `git update-index
|
`git update-index --untracked-cache` and `git update-index
|
||||||
--split-index`), Otherwise you can use `no` to have `git status`
|
--split-index`), Otherwise you can use `no` to have `git status`
|
||||||
return more quickly without showing untracked files.
|
return more quickly without showing untracked files.
|
||||||
+
|
|
||||||
The default can be changed using the status.showUntrackedFiles
|
The default can be changed using the status.showUntrackedFiles
|
||||||
configuration variable documented in linkgit:git-config[1].
|
configuration variable documented in linkgit:git-config[1].
|
||||||
|
--
|
||||||
|
|
||||||
--ignore-submodules[=<when>]::
|
--ignore-submodules[=<when>]::
|
||||||
Ignore changes to submodules when looking for changes. <when> can be
|
Ignore changes to submodules when looking for changes. <when> can be
|
||||||
@ -100,11 +102,12 @@ configuration variable documented in linkgit:git-config[1].
|
|||||||
--ignored[=<mode>]::
|
--ignored[=<mode>]::
|
||||||
Show ignored files as well.
|
Show ignored files as well.
|
||||||
+
|
+
|
||||||
|
--
|
||||||
The mode parameter is used to specify the handling of ignored files.
|
The mode parameter is used to specify the handling of ignored files.
|
||||||
It is optional: it defaults to 'traditional'.
|
It is optional: it defaults to 'traditional'.
|
||||||
+
|
|
||||||
The possible options are:
|
The possible options are:
|
||||||
+
|
|
||||||
- 'traditional' - Shows ignored files and directories, unless
|
- 'traditional' - Shows ignored files and directories, unless
|
||||||
--untracked-files=all is specified, in which case
|
--untracked-files=all is specified, in which case
|
||||||
individual files in ignored directories are
|
individual files in ignored directories are
|
||||||
@ -112,12 +115,13 @@ The possible options are:
|
|||||||
- 'no' - Show no ignored files.
|
- 'no' - Show no ignored files.
|
||||||
- 'matching' - Shows ignored files and directories matching an
|
- 'matching' - Shows ignored files and directories matching an
|
||||||
ignore pattern.
|
ignore pattern.
|
||||||
+
|
|
||||||
When 'matching' mode is specified, paths that explicitly match an
|
When 'matching' mode is specified, paths that explicitly match an
|
||||||
ignored pattern are shown. If a directory matches an ignore pattern,
|
ignored pattern are shown. If a directory matches an ignore pattern,
|
||||||
then it is shown, but not paths contained in the ignored directory. If
|
then it is shown, but not paths contained in the ignored directory. If
|
||||||
a directory does not match an ignore pattern, but all contents are
|
a directory does not match an ignore pattern, but all contents are
|
||||||
ignored, then the directory is not shown, but all contents are shown.
|
ignored, then the directory is not shown, but all contents are shown.
|
||||||
|
--
|
||||||
|
|
||||||
-z::
|
-z::
|
||||||
Terminate entries with NUL, instead of LF. This implies
|
Terminate entries with NUL, instead of LF. This implies
|
||||||
|
Loading…
Reference in New Issue
Block a user