public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox•com>
To: Jiang Xin <worldhello.net@gmail•com>
Cc: Git List <git@vger•kernel.org>
Subject: Re: [PATCH] documentation: clarify notes for clean.requireForce
Date: Tue, 27 Aug 2013 09:31:53 -0700	[thread overview]
Message-ID: <xmqqd2ozdrie.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <07b4019b473c2e6d46e75b5ae5ce3f431e4e74d0.1377612590.git.worldhello.net@gmail.com> (Jiang Xin's message of "Tue, 27 Aug 2013 22:11:29 +0800")

Jiang Xin <worldhello.net@gmail•com> writes:

> Add "-i" (interactive clean option) to clarify the documentation for
> "clean.requireForce" config variable. Also replace the example in
> `gitcli.txt` with safer git clean command.

Hmm, the former change may make sense, but I am not sure about the
latter.  The section is about showing examples of concatenating
command line options, and I find it far more appropriate to use
"clean -f", which is a lot more widely known than "clean -i", for
the intended audience, those who are learning how to compose the
command line options.

> Signed-off-by: Jiang Xin <worldhello.net@gmail•com>
> ---
>  Documentation/config.txt | 4 ++--
>  Documentation/gitcli.txt | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 8361380..547149d 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -795,8 +795,8 @@ browser.<tool>.path::
>  	working repository in gitweb (see linkgit:git-instaweb[1]).
>  
>  clean.requireForce::
> -	A boolean to make git-clean do nothing unless given -f
> -	or -n.   Defaults to true.
> +	A boolean to make git-clean do nothing unless given -i,
> +	-f or -n.   Defaults to true.
>  
>  color.branch::
>  	A boolean to enable/disable color in the output of
> diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
> index 9ac5088..4005a3b 100644
> --- a/Documentation/gitcli.txt
> +++ b/Documentation/gitcli.txt
> @@ -135,7 +135,7 @@ Aggregating short options
>  ~~~~~~~~~~~~~~~~~~~~~~~~~
>  Commands that support the enhanced option parser allow you to aggregate short
>  options. This means that you can for example use `git rm -rf` or
> -`git clean -fdx`.
> +`git clean -idx`.
>  
>  
>  Abbreviating long options

  reply	other threads:[~2013-08-27 16:32 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-08-27 14:11 [PATCH] documentation: clarify notes for clean.requireForce Jiang Xin
2013-08-27 16:31 ` Junio C Hamano [this message]
2013-08-28  1:28   ` [PATCH v2] " Jiang Xin

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=xmqqd2ozdrie.fsf@gitster.dls.corp.google.com \
    --to=gitster@pobox$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=worldhello.net@gmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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