gitignore.txt: fix slash-rules example

[tvasenin]

No description provided.

[gitgitgadget-git]

Welcome to GitGitGadget

Hi @tvasenin, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that either:

• Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
• Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

• Search: is:pr is:open "/allow"

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

[dscho]

/allow

[gitgitgadget-git]

User tvasenin is now allowed to use GitGitGadget.

[tvasenin]

/submit

[gitgitgadget-git]

Submitted as pull.1720.git.git.1715705582609.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-1720/tvasenin/tvasenin/gitignore-slash-rules-example-fix-v1

To fetch this version to local tag pr-git-1720/tvasenin/tvasenin/gitignore-slash-rules-example-fix-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-1720/tvasenin/tvasenin/gitignore-slash-rules-example-fix-v1

[gitgitgadget-git]

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Timofey Vasenin via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Timofey Vasenin <timofey.vasenin@gmail.com>
>
> Fix an apparent typo, introduced in:
> 1a58bad014 (gitignore.txt: make slash-rules more readable, 2019-06-04)
> ...
> diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
> index 5e0964ef419..7142fa10acc 100644
> --- a/Documentation/gitignore.txt
> +++ b/Documentation/gitignore.txt
> @@ -100,7 +100,7 @@ PATTERN FORMAT
>     will only match directories, otherwise the pattern can match both
>     files and directories.
>  
> - - For example, a pattern `doc/frotz/` matches `doc/frotz` directory,
> + - For example, a pattern `/doc/frotz/` matches `doc/frotz` directory,
>     but not `a/doc/frotz` directory; however `frotz/` matches `frotz`
>     and `a/frotz` that is a directory (all paths are relative from
>     the `.gitignore` file).

Are you sure this is a typo?

The text added by the same commit (taken from "git show 1a58bad014")
has this passage:

+ - The pattern `doc/frotz` and `/doc/frotz` have the same effect
+   in any `.gitignore` file. In other words, a leading slash
+   is not relevant  if there is already a middle slash in
+   the pattern.

So, if your updated /doc/frotz/ works as described (i.e. match
doc/frotz but not a/doc/frotz), then the original doc/frotz/ should
behave exactly the same way, no?  If you have a good reason to believe
that doc/frotz/ described there should be /doc/frotz/ instead, then
you need to also update that "have the same effect" paragraph.

There should already be an existing test that checks it somewhere
under t/; finding one is left as an exercise (or punishment) to
readers ;-).

It is easy to construct a test case from scratch.

    $ mkdir -p doc/frotz/ a/doc/frotz/
    $ >doc/frotz/foo
    $ >a/doc/frotz/bar
    $ echo doc/frotz >.gitignore
    $ git check-ignore -v doc/frotz/foo a/doc/frotz/bar
    .gitignore:1:doc/frotz	doc/frotz/foo

It seems that doc/frotz seems to work exactly as described, matching
with doc/frotz/foo but not with a/doc/frotz/bar, without a leading
slash, thanks to a slash in the middle.

So...