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>
This commit is contained in:
Wesley J. Landaker
2009-04-25 09:13:41 -06:00
committed by Junio C Hamano
parent 926337fe89
commit 911198f6c0

View File

@ -12,14 +12,17 @@ SYNOPSIS
DESCRIPTION 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 This allows cleaning the working tree by removing files that are not
specified, ignored files are also removed, allowing the removal of all under version control.
build products.
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 If any optional `<path>...` arguments are given, only those paths
are affected. are affected.
OPTIONS OPTIONS
------- -------
-d:: -d::