Skip to contentSkip to conversation

Documentation: default -u<mode> is 'normal'

PATCH In review Clemens Buchacher 2 participants 3 messages Jun 15, 2016 Documentation

lore
Share & tools
lore

Clemens Buchacher

author
#0 lore raw

PATCH 1/1 Documentation: default -u<mode> is 'normal'

git-commit's and git-status' default untracked status mode is 'normal', not 'all'.

Signed-off-by Clemens Buchacher <[email protected]>
---
 Documentation/git-commit.txt |    2 +-
 Documentation/git-status.txt |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/git-commit.txt +1 -1
index b586c0f..b4e2f1b 100644
@@ -214,7 +214,7 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
 
 -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.
Documentation/git-status.txt +1 -1
index dae190a..369277a 100644
@@ -38,7 +38,7 @@ OPTIONS
 
 -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. The possible options are:
Signature · 1 line
1.7.3.1.105.g84915
#1 lore raw
Quoted 4 lines · Clemens Buchacher

git-commit's and git-status' default untracked status mode is 'normal', not 'all'.

Signed-off-by Clemens Buchacher <[email protected]>

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.

Documentation/git-commit.txt FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) · line 220

Quoted 8 lines

...
-u[<mode>]::
--untracked-files[=<mode>]::

Documentation/git-commit.txt +1 -1
-	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.

author
#2 lore raw

PATCH 1/1 Documentation: clarify -u<mode> option defaults

Signed-off-by Clemens Buchacher <[email protected]>

---

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(-)
Documentation/git-commit.txt +6 -6
index b586c0f..8f89f6f 100644
@@ -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::
Documentation/git-status.txt +8 -8
index dae190a..5102a23 100644
@@ -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
Signature · 1 line
1.7.3.1.105.g84915