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

From: Junio C Hamano <gitster@pobox.com>
Date: May 5, 2009, 16:20 UTC
Message-ID: <7vk54v1py6.fsf@alter.siamese.dyndns.org>
In-Reply-To: <200905051426.18814.trast@student.ethz.ch>

Thomas Rast <trast@student.ethz.ch> writes:

Show 8 quoted lines

>  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:

Show 11 quoted lines

> 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.