On 03/06/2019 19:01, Junio C Hamano wrote:
Philip Oakley <philipoakley@xxxxxxxxxxxx> 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
design.
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
lock-in.
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
mistake?
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
alternate suggestion.
Philip
