[PATCH 2/2] Documentation: git-clean: make description more readable

From: Wesley J. Landaker <wjl@icecavern.net>
Date: Apr 25, 2009, 15:13 UTC
Message-ID: <1240672421-10309-3-git-send-email-wjl@icecavern.net>
In-Reply-To: <1240672421-10309-1-git-send-email-wjl@icecavern.net>

The existing text is a little bit awkward. This rewrites the description section to be more readable and friendly.

Signed-off-by: Wesley J. Landaker <wjl@icecavern.net>
---

This is a more major change, but since at least I and one other person I know have both stumbled on this section, I think making it more readable and friendly is a good change.

 Documentation/git-clean.txt |   13 ++++++++-----
 1 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 932d44d..43b2de7 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -12,14 +12,17 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Removes files unknown to git.  This allows cleaning the working tree
-of files that are not under version control.  If the '-x' option is
-specified, ignored files are also removed, allowing the removal of all
-build products.
+
+This allows cleaning the working tree by removing files that are not
+under version control.
+
+Normally, only files unknown to git are removed, but if the '-x'
+option is specified, ignored files are also removed. This can, for
+example, be useful to remove all build products.
+
 If any optional `<path>...` arguments are given, only those paths
 are affected.
 
-
 OPTIONS
 -------
 -d::

-- 
1.6.2.4