From: Johannes Sixt <j6t@kdbg.org>
To: "Dr. Adam Nielsen" <admin@in-ici.net>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH] make slash-rules more readable
Date: Sat, 18 May 2019 08:42:52 +0200 [thread overview]
Message-ID: <f80eb2e5-3285-40bd-018d-ff0c7e5e9ff5@kdbg.org> (raw)
In-Reply-To: <469c37d9-4491-9072-211f-d9d8614413e0@in-ici.net>
Am 17.05.19 um 23:43 schrieb Dr. Adam Nielsen:
>> Another thing that I noticed is that its not mentioned anywhere that
>> the pattern use a slash as a directory separator (instead of a
>> backslash), its only clear from the examples. Maybe its worth to
>> mention it in the "PATTERN FORMAT" section. Also its maybe worth to
>> introduce the term "leading slash" and "trailing slash" because they
>> will be of importance of the following paragraphs. Something like this
>> after the paragraph of "!":
>>
>> [...] for example, "\!important!.txt".
>>
>> A slash `/` is used as a directory separator.
>> A leading slash (that is if the pattern begins with a slash)
>> or a trailing slash (that is if the pattern ends with a slash)
>> have special meaning and are explained below.
>>
>> If the pattern contains a trailing slash, it would only find
>> a match with a directory. [...]
>>
>
>
> I changed my mind about this last addition. I think it is not very
> readable and there is no need to explain leading/trailing slash. Maybe
> one could just note it like this:
>
> [...] for example, "\!important!.txt".
>
> A slash `/` is used as a directory separator.
> A leading and trailing slash have special meaning
> and are explained in the following.
>
> If the pattern ends with a slash, it would only find
> a match with a directory. [...]
>
> then I would also add:
>
> If the pattern does not end with a slash, it would find a match
> with a file or directory.
>
>
> Two notes about two sentences that I proposed a while ago:
>
>> + - If the pattern contains no slash "`/`" (except an optional
> trailing slash),
>> + the ...
>
> I think that this sentence is not very readable. The exceptional case in
> the brackets makes it over complicated.
>
>> + - A pattern that contains a non-trailing slash is matched
>
> And I don't like this phrase either. I think its too easy to confuse it
> with "A pattern that contains no trailing slash".
>
> So I would suggest to replace both with the following:
>
> If the pattern contains no slash or only a trailing slash, [...].
> Otherwise (when it contains a non-trailing slash) the pattern
> is matched [...].
With all those new "if"s, "but"s, "otherwise"s, "when"s, and "except"s,
I have a feeling that the current way to say
If .... ends with a slash, then ... only directories... The trailing
slash is removed for the purpose of the remaining rules.
is still the best way to go forward. I do understand that this is a
rather technical way to explain things than a colloquial one, but it
also does remove a lot of conditionals and, therefore, mental burden.
-- Hannes
next prev parent reply other threads:[~2019-05-18 6:42 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-07 10:45 [PATCH] make slash-rules more readable 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 [this message]
2019-05-18 13:20 ` 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-31 7:44 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
2019-06-01 9:23 ` Philip Oakley
2019-06-04 12:34 ` Philip Oakley
2019-06-04 17:22 ` 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] ` <0c2894ce-7eab-8207-9af8-7ce5e779d4ec@iee.org>
2019-05-29 8:28 ` Dr. Adam Nielsen
2019-04-26 14:32 Dr. Adam Nielsen
Reply instructions:
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
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 \
--in-reply-to=f80eb2e5-3285-40bd-018d-ff0c7e5e9ff5@kdbg.org \
--to=j6t@kdbg.org \
--cc=admin@in-ici.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* 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
https://80x24.org/mirrors/git.git
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).