Add an option not to use link(src, dest) && unlink(src) when that is unreliable

[git.git] / Documentation / git-clean.txt

diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 8a114509f4a19b4fa6c6d8de8afdc94938d24b82..43b2de7db3b5f21ab9b3eb03e0c167892ae37f3f 100644 (file)
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -12,14 +12,17 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Removes files unknown to git.  This allows to clean the working tree
-from files that are not under version control.  If the '-x' option is
-specified, ignored files are also removed, allowing to remove 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::