Re: [PATCH] docs: .gitignore parsing is to the top of the repo

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 19, 2021, 18:36 UTC
Message-ID: <xmqqy2a2kv5z.fsf@gitster.g>
In-Reply-To: <52880F2B-FAD4-4E36-8662-A798B91B5C94@furrypaws.ca>

"Andrew Berry" <andrew@furrypaws.ca> writes:

Show 16 quoted lines

> On 6 Jul 2021, at 17:57, Junio C Hamano wrote:
>
>> If you do "toplevel" -> "top-level" while at it, perhaps we would
>> want to correct "work tree" -> "working tree".
>
> Rather than think of this as a one-off fix, I thought to look to see
> how many instances of each are currently used.
>
> toplevel: 246
> top-level: 119
> work tree: 538
> working tree: 2610
>
> Since many of these instances are in translated strings, and that the
> text is understandable with any of the variants, I don't think it's 
> worth changing. "Our standard is no standard" etc.

So using "working tree" and "toplevel" might be adjusting to majority, but I agree that there are so numerous that tweaking only one "toplevel" (or another "work tree") should not distract the main point of this patch.

Thanks for stepping back and thinking it carefully. I wish everybody did more of that ;-)

> That leaves bringing the note about the work tree earlier in the
> sentence. Here's a hopefully easier to read word-diff. Look good?

Sure, but the thing is that the version of the patch (with the change from toplevel to top-level) has already been in 'next' for more than a week.

Thanks.

Show 22 quoted lines

> diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
> index 53e7d5c914..b4c8b9c0de 100644
> --- a/Documentation/gitignore.txt
> +++ b/Documentation/gitignore.txt
> @@ -27,12 +27,11 @@ precedence, the last matching pattern decides the
> outcome):
>    them.
>
>  * Patterns read from a `.gitignore` file in the same directory
>    as the path, or in any parent [-directory, with patterns in the-]
> [-   higher level files-]{+directory+} (up to the toplevel of the work
>    [-tree)-]{+tree), with patterns in the higher level files+} being
>    overridden by those in
>    lower level files down to the directory containing the file. These
>    patterns
>    match relative to the location of the `.gitignore` file.  A project
>    normally
>    includes such `.gitignore` files in its repository, containing
>    patterns for
>    files generated as part of the project build.
>
>  * Patterns read from `$GIT_DIR/info/exclude`.