git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Clemens Buchacher <drizzd@aon.at>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation: default -u<mode> is 'normal'
Date: Mon, 21 Feb 2011 10:46:47 -0800	[thread overview]
Message-ID: <7vei71jkdk.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <20110219163008.GA16117@localhost> (Clemens Buchacher's message of "Sat\, 19 Feb 2011 17\:30\:08 +0100")

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.

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

  reply	other threads:[~2011-02-21 18:47 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-02-19 16:30 [PATCH] Documentation: default -u<mode> is 'normal' Clemens Buchacher
2011-02-21 18:46 ` Junio C Hamano [this message]
2011-02-21 20:05   ` [PATCH] Documentation: clarify -u<mode> option defaults Clemens Buchacher

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7vei71jkdk.fsf@alter.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=drizzd@aon.at \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).