[PATCH] documentation: clarify notes for clean.requireForce

2013-08-27 Thread Jiang Xin
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.

Signed-off-by: Jiang Xin worldhello@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
-- 
1.8.4.rc3.2.gf223459

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] documentation: clarify notes for clean.requireForce

2013-08-27 Thread Junio C Hamano
Jiang Xin worldhello@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@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
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html