Skip to content

Commit 911198f

Browse files
wjlgitster
authored andcommitted
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>
1 parent 926337f commit 911198f

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

Documentation/git-clean.txt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,17 @@ SYNOPSIS
1212

1313
DESCRIPTION
1414
-----------
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+
1923
If any optional `<path>...` arguments are given, only those paths
2024
are affected.
2125

22-
2326
OPTIONS
2427
-------
2528
-d::

0 commit comments

Comments
 (0)