diff options
| author | Wesley J. Landaker <wjl@icecavern.net> | 2009-04-25 15:13:41 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-04-25 16:29:38 (GMT) |
| commit | 911198f6c09e2a60451cf1a295ce4532ff11781c (patch) | |
| tree | 320a398e6ad6ca274744c712cfc9cd043adae8ea /Documentation/git-clean.txt | |
| parent | 926337fe89f99c690b721f00239e298f8b7cad28 (diff) | |
| download | git-911198f6c09e2a60451cf1a295ce4532ff11781c.zip git-911198f6c09e2a60451cf1a295ce4532ff11781c.tar.gz git-911198f6c09e2a60451cf1a295ce4532ff11781c.tar.bz2 | |
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>
Diffstat (limited to 'Documentation/git-clean.txt')
| -rw-r--r-- | Documentation/git-clean.txt | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 932d44d..43b2de7d 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 `<path>...` arguments are given, only those paths are affected. - OPTIONS ------- -d:: |