diff options
author | Martin Ågren <martin.agren@gmail.com> | 2019-09-07 16:12:47 +0200 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-09-09 11:05:51 -0700 |
commit | 2017956a192d0dbcecbba604a76082ff8bbd3e3d (patch) | |
tree | 47bbaca2cc153bccb3e981538b86febc8ee710c8 /Documentation/git-commit.txt | |
parent | 745f6812895b31c02b29bdfe4ae8e5498f776c26 (diff) | |
download | git-2017956a192d0dbcecbba604a76082ff8bbd3e3d.tar.gz |
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>
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r-- | Documentation/git-commit.txt | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 7628193284..afa7b75a23 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -282,18 +282,20 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) --untracked-files[=<mode>]:: Show untracked files. + +-- The mode parameter is optional (defaults to 'all'), and is used to specify the handling of untracked files; when -u is not used, the default is 'normal', i.e. show untracked files and directories. -+ + The possible options are: -+ + - 'no' - Show no untracked files - 'normal' - Shows untracked files and directories - 'all' - Also shows individual files in untracked directories. -+ + The default can be changed using the status.showUntrackedFiles configuration variable documented in linkgit:git-config[1]. +-- -v:: --verbose:: |