[GSoC PATCH v2] t2107: modernize path existence check

[QuantumDev-CERN]

CC: Pablo Sabater pabloosabaterr@gmail.com, Christian Couder christian.couder@gmail.com, Karthik Nayak karthik.188@gmail.com, Justin Tobler jltobler@gmail.com, Ayush Chandekar ayu.chandekar@gmail.com, Siddharth Asthana siddharthasthana31@gmail.com

[gitgitgadget]

Welcome to GitGitGadget

Hi @QuantumDev-CERN, 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>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
example.

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.

[QuantumDev-CERN]

/submit --subject-prefix="GSoC PATCH"

[gitgitgadget]

Error: User QuantumDev-CERN is not yet permitted to use GitGitGadget

[dscho]

/submit --subject-prefix="GSoC PATCH"

That's a creative hallucination of an option that does not exist ;-)

[dscho]

/allow

[gitgitgadget]

User QuantumDev-CERN is now allowed to use GitGitGadget.

[dscho]

/submit --subject-prefix="GSoC PATCH"

That's a creative hallucination of an option that does not exist ;-)

@QuantumDev-CERN Note that the patch prefix is determined based on whether the PR is a draft or not, and cannot be specified via the /submit command. If you want to see "[GSoC]" in the email subject, you need to put it into your PR title, as a prefix, like so: "[GSoC] t2107: modernize path existence check".

[QuantumDev-CERN]

/submit

[gitgitgadget]

Submitted as pull.2071.git.1773857555312.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-2071/QuantumDev-CERN/gsoc-microproject-v1

To fetch this version to local tag pr-2071/QuantumDev-CERN/gsoc-microproject-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-2071/QuantumDev-CERN/gsoc-microproject-v1

[gitgitgadget]

Junio C Hamano wrote on the Git mailing list (how to reply to this email):

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

> From: Aditya <adityabnw07@gmail.com>
>
> Replace '! test -f' with 'test_path_is_missing' for better
> debugging information when the assertion fails.

OK.

> Found using: git grep "test -[efd]" t/t????-*.sh

People seem to add the above to their test-path helper patches, but
unless the coverage of the work is fairly thorough and you want to
say "all the similar issues should be found with this command and I
addressed all of them", I do not see much point saying how you found
one of them and addressed it.

>
> Signed-off-by: Aditya <adityabnw07@gmail.com>
> ---
>     [GSoC] t2107: modernize path existence check
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2071%2FQuantumDev-CERN%2Fgsoc-microproject-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2071/QuantumDev-CERN/gsoc-microproject-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/2071
>
>  t/t2107-update-index-basic.sh | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/t/t2107-update-index-basic.sh b/t/t2107-update-index-basic.sh
> index cc72ead79f..3bffe5da8a 100755
> --- a/t/t2107-update-index-basic.sh
> +++ b/t/t2107-update-index-basic.sh
> @@ -86,7 +86,7 @@ test_expect_success '.lock files cleaned up' '
>  	# the_index.cache_changed is zero, rollback_lock_file fails
>  	git update-index --refresh --verbose >out &&
>  	test_must_be_empty out &&
> -	! test -f .git/index.lock
> +	test_path_is_missing .git/index.lock
>  	)
>  '
>  
>
> base-commit: ca1db8a0f7dc0dbea892e99f5b37c5fe5861be71

[gitgitgadget]

Pablo wrote on the Git mailing list (how to reply to this email):

Aditya <adityabnw07@gmail.com> writes:

> Replace '! test -f' with 'test_path_is_missing' for better
> debugging information when the assertion fails.

This seems fine but it could add more about why it is better,
something like: by reporting loudly what expectation was not met.
Also, If this is for GSoC when submitting the patches or anything
relevant to GSoC contributions add to the prefix with PATCH something
like: [GSoC PATCH] and CC your possible co-mentors. Read [1].

> Found using: git grep "test -[efd]" t/t????-*.sh

As Junio said in other microprojects reviews, including the search
command it's not very useful when you only address one instance.

[1]: https://git.github.io/General-Microproject-Information/ "about
microprojects information"

> Signed-off-by: Aditya <adityabnw07@gmail.com>
> ---
>     [GSoC] t2107: modernize path existence check
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2071%2FQuantumDev-CERN%2Fgsoc-microproject-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2071/QuantumDev-CERN/gsoc-microproject-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/2071
>
>  t/t2107-update-index-basic.sh | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/t/t2107-update-index-basic.sh b/t/t2107-update-index-basic.sh
> index cc72ead79f..3bffe5da8a 100755
> --- a/t/t2107-update-index-basic.sh
> +++ b/t/t2107-update-index-basic.sh
> @@ -86,7 +86,7 @@ test_expect_success '.lock files cleaned up' '
>         # the_index.cache_changed is zero, rollback_lock_file fails
>         git update-index --refresh --verbose >out &&
>         test_must_be_empty out &&
> -       ! test -f .git/index.lock
> +       test_path_is_missing .git/index.lock
>         )
>  '

Looks fine to me.

>
>
> base-commit: ca1db8a0f7dc0dbea892e99f5b37c5fe5861be71
> --
> gitgitgadget
>

[gitgitgadget]

User Pablo <pabloosabaterr@gmail.com> has been added to the cc: list.

[gitgitgadget]

Pablo wrote on the Git mailing list (how to reply to this email):

Junio C Hamano (<gitster@pobox.com>) writes:
>
> "QUANTUM via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
> > From: Aditya <adityabnw07@gmail.com>
> >
> > Replace '! test -f' with 'test_path_is_missing' for better
> > debugging information when the assertion fails.
>
> OK.
>
> > Found using: git grep "test -[efd]" t/t????-*.sh
>
> People seem to add the above to their test-path helper patches, but
> unless the coverage of the work is fairly thorough and you want to
> say "all the similar issues should be found with this command and I
> addressed all of them", I do not see much point saying how you found
> one of them and addressed it.

I think it is because of how it is explained on Ideas for microprojects [1].
It is written:

    Steps to Complete

    Find a test script using old-style path checks:

    git grep "test -[efd]" t/

and later says "Include which command you used to find the instances
in your commit message"

[1]: https://git.github.io/SoC-2026-Microprojects/ "Ideas for microprojects"

>
> >
> > Signed-off-by: Aditya <adityabnw07@gmail.com>
> > ---
> >     [GSoC] t2107: modernize path existence check
> >
> > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2071%2FQuantumDev-CERN%2Fgsoc-microproject-v1
> > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2071/QuantumDev-CERN/gsoc-microproject-v1
> > Pull-Request: https://github.com/gitgitgadget/git/pull/2071
> >
> >  t/t2107-update-index-basic.sh | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/t/t2107-update-index-basic.sh b/t/t2107-update-index-basic.sh
> > index cc72ead79f..3bffe5da8a 100755
> > --- a/t/t2107-update-index-basic.sh
> > +++ b/t/t2107-update-index-basic.sh
> > @@ -86,7 +86,7 @@ test_expect_success '.lock files cleaned up' '
> >       # the_index.cache_changed is zero, rollback_lock_file fails
> >       git update-index --refresh --verbose >out &&
> >       test_must_be_empty out &&
> > -     ! test -f .git/index.lock
> > +     test_path_is_missing .git/index.lock
> >       )
> >  '
> >
> >
> > base-commit: ca1db8a0f7dc0dbea892e99f5b37c5fe5861be71
>

[QuantumDev-CERN]

/submit

[gitgitgadget]

Submitted as pull.2071.v2.git.1773864455956.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-2071/QuantumDev-CERN/gsoc-microproject-v2

To fetch this version to local tag pr-2071/QuantumDev-CERN/gsoc-microproject-v2:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-2071/QuantumDev-CERN/gsoc-microproject-v2

[gitgitgadget]

This branch is now known as ai/t2107-test-path-is-helpers.

[gitgitgadget]

This patch series was integrated into seen via git@88e40e5.