From: Philip Oakley <email@example.com>
To: Junio C Hamano <firstname.lastname@example.org>
Cc: "Dr. Adam Nielsen" <email@example.com>, Git List <firstname.lastname@example.org>
Subject: Re: [PATCH] make slash-rules more readable
Date: Tue, 4 Jun 2019 11:40:49 +0100 [thread overview]
Message-ID: <email@example.com> (raw)
On 03/06/2019 19:01, Junio C Hamano wrote:
> Philip Oakley <firstname.lastname@example.org> writes:
>> From a user perspective, implementation issues shouldn't be part of
>> the description unless absolutely essential.
>> Most user aren't aware of the implementation so don't grok/understand
>> what the fuss is about and ignore it...
> Oh, absolutely. But unfortunately I do not see what that principle
> has anything to do with the comments you made in your message.
>>> Specifically, if you took my suggestion in an earlier review to
>>> explicitly say that leading slash is merely a workaround for a
>>> string without slash to anchor the pattern to the directory and
>>> it should be treated as if it does not exist otherwise, then ...
> Perhaps you thought "workaround" refers to some implementation
> glitch? That is not what the word means in that sentence. It is a
> technique to work around "you need a slash somewhere in the pattern
> to anchor it to a specific directory" that is a very user visible
It is the fact that we have ended up describing what needs to be done
from having had the implementation problem. Thus we (accidentally) lock
ourselves into a 'difficult to explain' situation.
> The user absolutely need to be aware of it, if s/he wants
> to anchor a pattern that does not have a slash
No. That (as I read it, regarding the need for an initial slash) is the
We should explain it from the other end - to anchor the pattern one
needs a slash either at the beginning or middle.
> (e.g. "I need a
> pattern to name/match the README file at this level but not in any
> of the subdirectories"), and an extra leading slash is a way to mark
> such a pattern that otherwise does not have a slash as anchored.
> The fact that the leading slash is such a syntactic marking of a
> pattern *and* is not a part of the pattern itself, would not help
> you understand the implementation, but you need to know it in order
> to use that feature effectively.
>>>> + - The pattern `doc/frotz` and `/doc/frotz` have the same effect
>>>> + in any `.gitignore` file. Both pattern contain a non-trailing
>>>> + slash and thus match relative to the location of the
>>>> + `.gitignore` file.
>>> ... this paragraph wouldn't have been necessary.
>> ...leading to that user mistake having to be explained in numerous Q&A
>> threads - Why can't we an explicit explanation of this common user
>> Arguably the issue is the special trailing slash rule getting
>> users confused..
> What common user mistake? The above is about leading slash rule, by
> the way, so perhaps you are getting confused?
We do get a reasonable number of queries to the list regarding
.gitignore patterns which generally indicate that user have been
confused and failed to understand the overall man page description (both
leading and training slashes being somehow special but exactly how they
haven't fully fathomed..) (and plenty on StackOverflow)
I'll ad some more feedback to Adam's side of the thread, and a possible
next prev parent reply other threads:[~2019-06-04 10:40 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-31 7:44 [PATCH] make slash-rules more readable Dr. Adam Nielsen
2019-05-31 16:30 ` Junio C Hamano
2019-05-31 17:24 ` Dr. Adam Nielsen
2019-05-31 17:40 ` Junio C Hamano
2019-06-01 9:33 ` Philip Oakley
2019-06-02 9:01 ` Dr. Adam Nielsen
2019-06-03 18:01 ` Junio C Hamano
2019-06-04 10:40 ` Philip Oakley [this message]
2019-06-01 9:23 ` Philip Oakley
2019-06-04 12:34 ` Philip Oakley
2019-06-04 17:22 ` Dr. Adam Nielsen
-- strict thread matches above, loose matches on Subject: below --
2020-02-15 3:08 Pavel Ivashkov
2019-06-04 17:34 Dr. Adam Nielsen
2019-06-25 11:05 ` Dr. Adam Nielsen
2019-06-25 11:31 ` Philip Oakley
2019-06-27 17:10 ` Dr. Adam Nielsen
2019-07-04 10:40 ` Philip Oakley
2019-07-04 10:46 ` Philip Oakley
2019-06-27 17:43 ` Junio C Hamano
2019-06-02 9:04 Dr. Adam Nielsen
2019-05-31 18:17 Dr. Adam Nielsen
2019-05-31 18:16 Dr. Adam Nielsen
2019-05-18 14:13 Dr. Adam Nielsen
2019-05-19 1:59 ` Junio C Hamano
2019-05-19 6:59 ` Johannes Sixt
2019-05-18 14:07 Dr. Adam Nielsen
2019-05-18 19:34 ` Philip Oakley
2019-05-19 15:33 ` Dr. Adam Nielsen
[not found] ` <email@example.com>
2019-05-29 8:28 ` Dr. Adam Nielsen
2019-05-07 10:45 Dr. Adam Nielsen
2019-05-08 5:33 ` Junio C Hamano
2019-05-12 9:56 ` Dr. Adam Nielsen
2019-05-17 21:43 ` Dr. Adam Nielsen
2019-05-18 6:42 ` Johannes Sixt
2019-05-18 13:20 ` Dr. Adam Nielsen
2019-04-26 14:32 Dr. Adam Nielsen
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).