summaryrefslogtreecommitdiff
path: root/Documentation/git-status.txt
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2015-10-16 14:32:33 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2015-10-16 14:32:33 -0700
commitbe4d6f4c7f94541fac1a06e4c04acc2d60de1f8c (patch)
treeb4280f474cec388974fd48b61f5cac669433a169 /Documentation/git-status.txt
parentMerge branch 'pt/pull-builtin' into maint (diff)
parentDocumentation: explain optional arguments better (diff)
downloadtgif-be4d6f4c7f94541fac1a06e4c04acc2d60de1f8c.tar.xz
Merge branch 'mm/keyid-docs' into maint
Very small number of options take a parameter that is optional (which is not a great UI element as they can only appear at the end of the command line). Add notice to documentation of each and every one of them. * mm/keyid-docs: Documentation: explain optional arguments better Documentation/grep: fix documentation of -O Documentation: use 'keyid' consistently, not 'key-id'
Diffstat (limited to 'Documentation/git-status.txt')
-rw-r--r--Documentation/git-status.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 335f312335..e1e8f57cdd 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -53,8 +53,9 @@ OPTIONS
--untracked-files[=<mode>]::
Show untracked files.
+
-The mode parameter is optional (defaults to 'all'), and 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
+stuck to the option (e.g. `-uno`, but not `-u no`).
+
The possible options are:
+