Re: [PATCH] Documentation: default -u<mode> is 'normal'

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 21, 2011, 18:46 UTC
Message-ID: <7vei71jkdk.fsf@alter.siamese.dyndns.org>
In-Reply-To: <20110219163008.GA16117@localhost>

Clemens Buchacher <drizzd@aon.at> writes:

> git-commit's and git-status' default untracked status mode is
> 'normal', not 'all'.
>
> Signed-off-by: Clemens Buchacher <drizzd@aon.at>

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.

Show 8 quoted lines

> ...
>  -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.