Documentation: git-clean: make description more readable
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>
Wesley J. Landaker committed
Apr 25, 2009 at 09:13 UTC
911198f6c09e2a60451cf1a295ce4532ff11781c
1 file changed
+8
-5
Documentation/git-clean.txt
+8
-5
@@ -12,14 +12,17 @@ SYNOPSIS
12
13
DESCRIPTION
14
-----------
15
-Removes files unknown to git. This allows cleaning the working tree
16
-of files that are not under version control. If the '-x' option is
17
-specified, ignored files are also removed, allowing the removal of all
18
-build products.
15
+
16
+This allows cleaning the working tree by removing files that are not
17
+under version control.
18
+
19
+Normally, only files unknown to git are removed, but if the '-x'
20
+option is specified, ignored files are also removed. This can, for
21
+example, be useful to remove all build products.
22
+
23
If any optional `<path>...` arguments are given, only those paths
24
are affected.
25
22
-
26
OPTIONS
27
-------
28
-d::