Code

Documentation: git-clean: make description more readable
authorWesley J. Landaker <wjl@icecavern.net>
Sat, 25 Apr 2009 15:13:41 +0000 (09:13 -0600)
committerJunio C Hamano <gitster@pobox.com>
Sat, 25 Apr 2009 16:29:38 +0000 (09:29 -0700)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-clean.txt

index 932d44daff82e461c3b797ebb91ed8f8a05bdb57..43b2de7db3b5f21ab9b3eb03e0c167892ae37f3f 100644 (file)
@@ -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::