From 911198f6c09e2a60451cf1a295ce4532ff11781c Mon Sep 17 00:00:00 2001 From: "Wesley J. Landaker" Date: Sat, 25 Apr 2009 09:13:41 -0600 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 932d44daf..43b2de7db 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 `...` arguments are given, only those paths are affected. - OPTIONS ------- -d:: -- 2.26.2