Clemens Buchacher [off-list ref] writes:
git-commit's and git-status' default untracked status mode is
'normal', not 'all'.
Signed-off-by: Clemens Buchacher <redacted>
I wouldn't say there is no problem in this part of the documentation, but
I think the "default" you are touching is not entirely incorrect. It is
talking about what happens when you give only -u without saying <mode>,
and I think <mode> _does_ default to 'all'.
When the command is _not_ given any "-u" option, the behaviour of it does
default to "handle untracked files in the 'normal'" mode.
...
-u[<mode>]::
--untracked-files[=<mode>]::
- Show untracked files (Default: 'all').
+ Show untracked files (Default: 'normal').
+
The mode parameter is optional, and is used to specify
the handling of untracked files.
So either
Show untracked files (<mode> defaults to 'all')
The mode parameter is optional, and is used to specify the
handling of untracked files; when -u is not used, the default is
'normal', i.e. _show x and y and z_
(I'm too lazy to look x/y/z up, so please fill in the blanks).
or
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 x and y and z_
I don't have a strong preference either way, but if I had to choose I
probably would go with the latter.
Signed-off-by: Clemens Buchacher <redacted>
---
Hi Junio,
Ok, with that we should be able to avoid any future confusion.
Thanks for clarifying.
Clemens
Documentation/git-commit.txt | 12 ++++++------
Documentation/git-status.txt | 16 ++++++++--------
2 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index b586c0f..8f89f6f 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -214,10 +214,11 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
-u[<mode>]::
--untracked-files[=<mode>]::
- Show untracked files (Default: 'all').
+ Show untracked files.
+
-The mode parameter is optional, and is used to specify
-the handling of 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:
+
@@ -225,9 +226,8 @@ The possible options are:
- 'normal' - Shows untracked files and directories
- 'all' - Also shows individual files in untracked directories.
+
-See linkgit:git-config[1] for configuration variable
-used to change the default for when the option is not
-specified.
+The default can be changed using the status.showUntrackedFiles
+configuration variable documented in linkgit:git-config[1].
-v::
--verbose::
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index dae190a..5102a23 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -38,20 +38,20 @@ OPTIONS
-u[<mode>]::
--untracked-files[=<mode>]::
- Show untracked files (Default: 'all').
+ Show untracked files.
+
-The mode parameter is optional, and is used to specify
-the handling of untracked files. The possible options are:
+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.
---
+
-See linkgit:git-config[1] for configuration variable
-used to change the default for when the option is not
-specified.
+The default can be changed using the status.showUntrackedFiles
+configuration variable documented in linkgit:git-config[1].
--ignore-submodules[=<when>]::
Ignore changes to submodules when looking for changes. <when> can be
--
1.7.3.1.105.g84915