Thread (3 messages) flat view 3 messages, 3 authors, 2016-06-15

Re: [PATCH] Documentation: Clarify which paths git-clean will affect

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:46:42

Thomas Rast [off-list ref] writes:
 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.
+If any optional `<path>...` arguments are given, those paths are
+affected.  Otherwise, the cleaning starts at the current directory.
With or without path limiters, clean does not look outside the current
directory; I think the "otherwise" makes things worse than the original.

I'd suggest not touching this paragraph at all, but instead say something
like this at the beginning:
quoted hunk
diff --git i/Documentation/git-clean.txt w/Documentation/git-clean.txt
index 43b2de7..3550fc0 100644
--- i/Documentation/git-clean.txt
+++ w/Documentation/git-clean.txt
@@ -13,15 +13,15 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-This allows cleaning the working tree by removing files that are not
+Cleans the working tree by recursively removing files that are not
 under version control.
    Cleans the working tree by recursively removing files that are not
    under version control, starting from the current directory.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help