Skip to content

Better support for customising context lines in --patch commands #1915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

NinjaInShade
Copy link

@NinjaInShade NinjaInShade commented May 4, 2025

This series of patches attempt to give --interactive/--patch compatible builtins ("add", "commit", "checkout", "reset", "restore" and "stash") better support and nicer experience for configuring how many context lines are shown in diffs through a variety of ways.

Prior to these patches, the user could not choose how many context lines they saw in --patch commands (apart from one workaround by using GIT_DIFF_OPTS=-u<number> ..., however this isn't a good user experience or a persistent solution). Additionally, the behaviour around reading from the diff.context and diff.interHunkContext configs was also inconsistent with other diff generating commands such as "log -p".

The summarised changes below hopefully make this experience better and fix some inconsistencies:

  • diff.context and diff.interHunkContext configs are now respected by --patch compatible commands
  • --unified and --inter-hunk-context command line options have been added to --patch compatible commands (which take prescendence over file configs)
  • "add" and "commit" in --interactive mode now expose a new "context" subcommand which configures the amount of context lines you wish to see in subsequent diffs generated from other subcommands such as "patch" or "diff"

The original discussion for this can be read at:

Changes since v1:

  • Update commit descriptions
  • Update tests to use the more modern and robust test_grep and test_config utils
  • Reword some documentation / user messages
  • Ensure each commit is atomic and builds/passes tests on it's own
  • Make new command line options DRY
  • Add tests for interhunk context interaction
  • Error if context config/command line options are negative
  • Drop previous last commit to do with new subcommand for --interactive add/commit. My motivations behind this patch series originally where quite simple, just for add-patch commands to respect context configs. This subcommand, after the discussion in v1, will require more thought and a larger implementation that what I had anticipated. I would prefer to leave this for another time as it's the least impactful but the most time intensive and complicated idea.

Changes since v2:

  • Update tests to only test single command (following Philip's suggestion)
  • Add negative option checks
  • Minor commit re-wording

Changes since v3:

  • Update commit descriptions
  • Read struct properties directly instead of assigning to variables first
  • Simplify config setting / error checking
  • Remove redundant tests in later commit as they were replaced with better test(s)
  • Change tests to use single quotes (this messes with the grep so was unable to explicitly test single quotes in the error messages, so decided to use regex . instead, which is what some other tests that have this problem seem to use as well)

cc: "Kristoffer Haugsbakk" [email protected]
cc: Eric Sunshine [email protected]
cc: Christian Couder [email protected]
cc: Phillip Wood [email protected]

Copy link

gitgitgadget bot commented May 4, 2025

Welcome to GitGitGadget

Hi @NinjaInShade, 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 <[email protected]>, Ill Takalook <[email protected]>

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:

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 [email protected], 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.

@derrickstolee
Copy link

/allow

Copy link

gitgitgadget bot commented May 5, 2025

User NinjaInShade is now allowed to use GitGitGadget.

WARNING: NinjaInShade has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

@NinjaInShade NinjaInShade changed the title Increased --unified support for --patch commands Better support for customising context lines in --patch commands May 5, 2025
@NinjaInShade NinjaInShade force-pushed the interactive-patch-context branch 2 times, most recently from 9b90dc6 to b4b7854 Compare May 5, 2025 07:37
@NinjaInShade
Copy link
Author

/submit

Copy link

gitgitgadget bot commented May 5, 2025

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1915/NinjaInShade/interactive-patch-context-v1

To fetch this version to local tag pr-1915/NinjaInShade/interactive-patch-context-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1915/NinjaInShade/interactive-patch-context-v1

Copy link

gitgitgadget bot commented May 5, 2025

User "Kristoffer Haugsbakk" <[email protected]> has been added to the cc: list.

Copy link

gitgitgadget bot commented May 5, 2025

User Eric Sunshine <[email protected]> has been added to the cc: list.

@NinjaInShade
Copy link
Author

NinjaInShade commented May 5, 2025 via email

Copy link

gitgitgadget bot commented May 6, 2025

User Christian Couder <[email protected]> has been added to the cc: list.

Copy link

gitgitgadget bot commented May 6, 2025

User Phillip Wood <[email protected]> has been added to the cc: list.

@NinjaInShade NinjaInShade force-pushed the interactive-patch-context branch 2 times, most recently from cf726da to 973dfad Compare May 10, 2025 12:41
@NinjaInShade
Copy link
Author

/submit

Copy link

gitgitgadget bot commented May 10, 2025

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1915/NinjaInShade/interactive-patch-context-v2

To fetch this version to local tag pr-1915/NinjaInShade/interactive-patch-context-v2:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1915/NinjaInShade/interactive-patch-context-v2

@@ -63,7 +63,7 @@ test_expect_success 'setup (initial)' '
'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"Leon Michalak via GitGitGadget" <[email protected]> writes:

> From: Leon Michalak <[email protected]>
>
> Refactor to use the modern "test_grep" test utility instead of regular
> "grep" which provides better debug information if tests fail.
>
> This is a prerequisite to the commits that follow which add to both test
> files.
>
> Signed-off-by: Leon Michalak <[email protected]>
> ---

These mostly look sensible, but I would title & phrase the commit
description to 'use "test_grep"', not 'refactor to &'.  It's shorter
and more direct ;-)

Thanks.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Leon Michalak wrote (reply to this):

On Mon, 12 May 2025 at 14:42, Junio C Hamano <[email protected]> wrote:
> These mostly look sensible, but I would title & phrase the commit
> description to 'use "test_grep"', not 'refactor to &'.  It's shorter
> and more direct ;-)

Thanks - will make sure to change that in v3 :)

@@ -0,0 +1,10 @@
`-U<n>`::
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"Leon Michalak via GitGitGadget" <[email protected]> writes:

> diff --git a/Documentation/diff-context-options.adoc b/Documentation/diff-context-options.adoc
> new file mode 100644
> index 000000000000..e161260358ff
> --- /dev/null
> +++ b/Documentation/diff-context-options.adoc
> @@ -0,0 +1,10 @@
> +`-U<n>`::
> +`--unified=<n>`::
> +	Generate diffs with _<n>_ lines of context. Defaults to `diff.context`
> +	or 3 if the config option is unset.
> +
> +`--inter-hunk-context=<n>`::
> +	Show the context between diff hunks, up to the specified _<number>_
> +	of lines, thereby fusing hunks that are close to each other.
> +	Defaults to `diff.interHunkContext` or 0 if the config option
> +	is unset.

It might not be trivial to do but I wonder if we cannot do better
than this to share more of the same text across manual pages.  These
two being options understood by `git diff`, we certainly have an
existing description for them, no?

Other than that, looking good to me.

Thanks.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Leon Michalak wrote (reply to this):

On Mon, 12 May 2025 at 17:45, Junio C Hamano <[email protected]> wrote:
> It might not be trivial to do but I wonder if we cannot do better
> than this to share more of the same text across manual pages.  These
> two being options understood by `git diff`, we certainly have an
> existing description for them, no?

Yes, I did of course notice documentation for `git diff` also has
these; ultimately my justification for not changing that to use this
new .adoc include as well was for a couple reasons:
- these two options are not together in the `git diff` documentation
(not *so* important, and they probably should actually be together?)
- there is an extra if def which adds on "implies --patch" text in the
`git diff` documentation which isn't the behaviour the add-patch
commands are going for, so that makes the intent a little different
here

But would be good to hear if anyone else has any thoughts.

Copy link

gitgitgadget bot commented May 12, 2025

This patch series was integrated into seen via git@0945e76.

Copy link

gitgitgadget bot commented Jul 9, 2025

This patch series was integrated into seen via git@e1e400e.

Copy link

gitgitgadget bot commented Jul 9, 2025

On the Git mailing list, Leon Michalak wrote (reply to this):

I will respond to everything soon I hope, life has been in the way and
I didn't anticipate so many comments :-)

Based on a skim read of the comments, the main thing I'm not sure I
will be able to achieve is implementing the valid value range that a
Rene has been working on as I don't have that context, but I'm not
sure if this is a necessity to add?

Copy link

gitgitgadget bot commented Jul 9, 2025

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

Leon Michalak <[email protected]> writes:

> I will respond to everything soon I hope, life has been in the way and
> I didn't anticipate so many comments :-)

Sure, no problem.  

Historically, summer is a slower season and these messages I sent
are primarily for me to keep track of topics on flight.  "No, I am
on vacation for a few more weeks" would have been perfectly fine
response ;-).

> Based on a skim read of the comments, the main thing I'm not sure I
> will be able to achieve is implementing the valid value range that a
> Rene has been working on as I don't have that context, but I'm not
> sure if this is a necessity to add?

Copy link

gitgitgadget bot commented Jul 9, 2025

This patch series was integrated into seen via git@80bec6b.

Copy link

gitgitgadget bot commented Jul 10, 2025

There was a status update in the "Cooking" section about the branch lm/add-p-context on the Git mailing list:

"git add/etc -p" now honors diff.context configuration variable,
and learns to honor -U<n> option.

Expecting a response.
cf. <[email protected]>
source: <[email protected]>

Copy link

gitgitgadget bot commented Jul 11, 2025

This patch series was integrated into seen via git@c70d294.

Copy link

gitgitgadget bot commented Jul 11, 2025

This patch series was integrated into seen via git@9c6acd9.

Copy link

gitgitgadget bot commented Jul 14, 2025

This patch series was integrated into seen via git@ad41dfd.

Copy link

gitgitgadget bot commented Jul 14, 2025

There was a status update in the "Cooking" section about the branch lm/add-p-context on the Git mailing list:

"git add/etc -p" now honors diff.context configuration variable,
and learns to honor -U<n> option.

Expecting responses.
cf. <[email protected]>
source: <[email protected]>

Copy link

gitgitgadget bot commented Jul 14, 2025

There was a status update in the "Cooking" section about the branch lm/add-p-context on the Git mailing list:

"git add/etc -p" now honors diff.context configuration variable,
and learns to honor -U<n> option.

Expecting responses.
cf. <[email protected]>
source: <[email protected]>

Copy link

gitgitgadget bot commented Jul 16, 2025

This patch series was integrated into seen via git@9ba8030.

Copy link

gitgitgadget bot commented Jul 16, 2025

This patch series was integrated into seen via git@fab972c.

Copy link

gitgitgadget bot commented Jul 16, 2025

This patch series was integrated into seen via git@1c90a03.

Copy link

gitgitgadget bot commented Jul 17, 2025

This patch series was integrated into seen via git@639ba58.

Copy link

gitgitgadget bot commented Jul 18, 2025

There was a status update in the "Cooking" section about the branch lm/add-p-context on the Git mailing list:

"git add/etc -p" now honors diff.context configuration variable,
and learns to honor -U<n> option.

Expecting responses.
cf. <[email protected]>
source: <[email protected]>

Copy link

gitgitgadget bot commented Jul 18, 2025

This patch series was integrated into seen via git@d2162ee.

Copy link

gitgitgadget bot commented Jul 18, 2025

This patch series was integrated into seen via git@10c4bc2.

Copy link

gitgitgadget bot commented Jul 18, 2025

This patch series was integrated into seen via git@eba0c7a.

As a preparatory clean-up, use the "test_grep" test utility instead of
regular "grep" which provides better debug information if tests fail.

Signed-off-by: Leon Michalak <[email protected]>
Use the modern "test_config" test utility instead of manual"git config"
as the former provides clean up on test completion.

This is a prerequisite to the commits that follow which add to this test
file.

Signed-off-by: Leon Michalak <[email protected]>
Various builtins that use add-patch infrastructure do not respect
the user's diff.context and diff.interHunkContext file configurations.

The user may be used to seeing their diffs with customized context size,
but not in the patches "git add -p" shows them to pick from.

Teach add-patch infrastructure to read these configuration variables and
pass their values when spawning the underlying plumbing commands as
their command line option.

Signed-off-by: Leon Michalak <[email protected]>
This patch compliments the previous commit, where builtins that use
add-patch infrastructure now respect diff.context and
diff.interHunkContext file configurations.

In particular, this patch helps users who don't want to set persistent
context configurations or just want a way to override them on a one-time
basis, by allowing the relevant builtins to accept corresponding command
line options that override the file configurations.

This mimics commands such as diff and log, which allow for both context
file configuration and command line overrides.

Signed-off-by: Leon Michalak <[email protected]>
@NinjaInShade NinjaInShade force-pushed the interactive-patch-context branch from b68c58b to 2774b93 Compare July 19, 2025 12:26
@NinjaInShade
Copy link
Author

/submit

Copy link

gitgitgadget bot commented Jul 19, 2025

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1915/NinjaInShade/interactive-patch-context-v4

To fetch this version to local tag pr-1915/NinjaInShade/interactive-patch-context-v4:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1915/NinjaInShade/interactive-patch-context-v4

Copy link

gitgitgadget bot commented Jul 21, 2025

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

"Leon Michalak via GitGitGadget" <[email protected]> writes:

> Changes since v3:
>
>  * Update commit descriptions
>  * Read struct properties directly instead of assigning to variables first
>  * Simplify config setting / error checking
>  * Remove redundant tests in later commit as they were replaced with better
>    test(s)
>  * Change tests to use single quotes (this messes with the grep so was
>    unable to explicitly test single quotes in the error messages, so decided
>    to use regex . instead, which is what some other tests that have this
>    problem seem to use as well)

All of the above looked reasonably well done.  Will replace.

Unless there are objections, let me mark the topic for 'next' soonish.

Thanks.

Copy link

gitgitgadget bot commented Jul 21, 2025

This patch series was integrated into seen via git@fd5f5d8.

@@ -0,0 +1,10 @@
`-U<n>`::
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Phillip Wood wrote (reply to this):

Hi Leon

On 19/07/2025 13:28, Leon Michalak via GitGitGadget wrote:
> From: Leon Michalak <[email protected]>
> > This patch compliments the previous commit, where builtins that use
> add-patch infrastructure now respect diff.context and
> diff.interHunkContext file configurations.
> > In particular, this patch helps users who don't want to set persistent
> context configurations or just want a way to override them on a one-time
> basis, by allowing the relevant builtins to accept corresponding command
> line options that override the file configurations.
> > This mimics commands such as diff and log, which allow for both context
> file configuration and command line overrides.

Thanks for updating the quoting in the tests. Unfortunately this patch now deletes the tests added in the last commit which I don't think is correct.

>   > -test_expect_success 'add -p respects diff.context' '
> -	test_write_lines a b c d e f g h i j k l m >file &&
I think there is some confusion here - why are we deleting the tests added in the last commit? This removes the test coverage for diff.context and diff.interHunkContext

> +for cmd in add checkout restore 'commit -m file'
> +do
> +	test_expect_success "${cmd%% *} accepts -U and --inter-hunk-context" '
> +		test_write_lines a b c d e f g h i j k l m n o p q r s t u v >file &&
> +		git add file &&
> +		test_write_lines a b c d e F g h i j k l m n o p Q r s t u v >file &&
> +		echo y | git -c diff.context=5 -c diff.interhunkcontext=1 \
> +			$cmd -p -U 4 --inter-hunk-context 2 >actual &&
> +		test_grep "@@ -2,20 +2,20 @@" actual
> +	'
> +done
> +
> +test_expect_success 'reset accepts -U and --inter-hunk-context' '
> +	test_write_lines a b c d e f g h i j k l m n o p q r s t u v >file &&
> +	git commit -m file file &&
> +	test_write_lines a b c d e F g h i j k l m n o p Q r s t u v >file &&
>   	git add file &&
> -	test_write_lines a b c d e f G h i j k l m >file &&
> -	echo y | git -c diff.context=5 add -p >actual &&
> -	test_grep "@@ -2,11 +2,11 @@" actual
> +	echo y | git -c diff.context=5 -c diff.interhunkcontext=1 \
> +		reset -p -U 4 --inter-hunk-context 2 >actual &&
> +	test_grep "@@ -2,20 +2,20 @@" actual
>   '
>   > -test_expect_success 'add -p respects diff.interHunkContext' '
> -	test_write_lines a b c d e f g h i j k l m n o p q r s >file &&
> -	git add file &&
> -	test_write_lines a b c d E f g i i j k l m N o p q r s >file &&
> -	echo y | git -c diff.interhunkcontext=2 add -p >actual &&
> -	test_grep "@@ -2,16 +2,16 @@" actual

This is also deleting a test added in the last patch

> +test_expect_success 'stash accepts -U and --inter-hunk-context' '
> +	test_write_lines a b c d e F g h i j k l m n o p Q r s t u v >file &&
> +	git commit -m file file &&
> +	test_write_lines a b c d e f g h i j k l m n o p q r s t u v >file &&
> +	echo y | git -c diff.context=5 -c diff.interhunkcontext=1 \
> +		stash -p -U 4 --inter-hunk-context 2 >actual &&
> +	test_grep "@@ -2,20 +2,20 @@" actual
>   '
>   > -test_expect_success 'add -p rejects negative diff.context' '
> -	test_config diff.context -1 &&
> -	test_must_fail git add -p 2>output &&
> -	test_grep "diff.context cannot be negative" output
> -'

and so is this. The tests you're adding look good but we shouldn't be deleting the existing ones.

> +for cmd in add checkout commit reset restore "stash save" "stash push"
> +do
> +	test_expect_success "$cmd rejects invalid context options" '
> +		test_must_fail git $cmd -p -U -3 2>actual &&
> +		cat actual | echo &&
> +		test_grep -e ".--unified. cannot be negative" actual &&
> +
> +		test_must_fail git $cmd -p --inter-hunk-context -3 2>actual &&
> +		test_grep -e ".--inter-hunk-context. cannot be negative" actual &&
> +
> +		test_must_fail git $cmd -U 7 2>actual &&
> +		test_grep -E ".--unified. requires .(--interactive/)?--patch." actual &&
> +
> +		test_must_fail git $cmd --inter-hunk-context 2 2>actual &&
> +		test_grep -E ".--inter-hunk-context. requires .(--interactive/)?--patch." actual
> +	'
> +done

This looks good as well
>   test_done
As I said last time I do not think the tests below add any value. They also do not compensate for the removal of the tests for diff.context that are deleted above as they all pass -U on the commandline.

> diff --git a/t/t4055-diff-context.sh b/t/t4055-diff-context.sh
> index 1384a8195705..0158fe6568cb 100755
> --- a/t/t4055-diff-context.sh
> +++ b/t/t4055-diff-context.sh
> @@ -58,6 +58,36 @@ test_expect_success 'The -U option overrides diff.context' '
>   	test_grep ! "^ firstline" output
>   '
>   > +test_expect_success 'The -U option overrides diff.context for "add"' '
> +	test_config diff.context 8 &&
> +	git add -U4 -p >output &&
> +	test_grep ! "^ firstline" output
> +'
> +
> +test_expect_success 'The -U option overrides diff.context for "commit"' '
> +	test_config diff.context 8 &&
> +	! git commit -U4 -p >output &&
> +	test_grep ! "^ firstline" output
> +'
> +
> +test_expect_success 'The -U option overrides diff.context for "checkout"' '
> +	test_config diff.context 8 &&
> +	git checkout -U4 -p >output &&
> +	test_grep ! "^ firstline" output
> +'
> +
> +test_expect_success 'The -U option overrides diff.context for "stash"' '
> +	test_config diff.context 8 &&
> +	! git stash -U4 -p >output &&
> +	test_grep ! "^ firstline" output
> +'
> +
> +test_expect_success 'The -U option overrides diff.context for "restore"' '
> +	test_config diff.context 8 &&
> +	git restore -U4 -p >output &&
> +	test_grep ! "^ firstline" output
> +'
> +
>   test_expect_success 'diff.context honored by "diff"' '
>   	test_config diff.context 8 &&
>   	git diff >output &&

Thanks

Phillip

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Leon Michalak wrote (reply to this):

Hey Philip, looking again for a second time and re-reading previous
replies on this thread, I think I misunderstood a previous reply.

I will add these back as soon as I can get back to the PC, thanks for
spotting that!

On Tue, 22 Jul 2025 at 17:02, Phillip Wood <[email protected]> wrote:
>
> Hi Leon
>
> On 19/07/2025 13:28, Leon Michalak via GitGitGadget wrote:
> > From: Leon Michalak <[email protected]>
> >
> > This patch compliments the previous commit, where builtins that use
> > add-patch infrastructure now respect diff.context and
> > diff.interHunkContext file configurations.
> >
> > In particular, this patch helps users who don't want to set persistent
> > context configurations or just want a way to override them on a one-time
> > basis, by allowing the relevant builtins to accept corresponding command
> > line options that override the file configurations.
> >
> > This mimics commands such as diff and log, which allow for both context
> > file configuration and command line overrides.
>
> Thanks for updating the quoting in the tests. Unfortunately this patch
> now deletes the tests added in the last commit which I don't think is
> correct.
>
> >
> > -test_expect_success 'add -p respects diff.context' '
> > -     test_write_lines a b c d e f g h i j k l m >file &&
> I think there is some confusion here - why are we deleting the tests
> added in the last commit? This removes the test coverage for
> diff.context and diff.interHunkContext
>
> > +for cmd in add checkout restore 'commit -m file'
> > +do
> > +     test_expect_success "${cmd%% *} accepts -U and --inter-hunk-context" '
> > +             test_write_lines a b c d e f g h i j k l m n o p q r s t u v >file &&
> > +             git add file &&
> > +             test_write_lines a b c d e F g h i j k l m n o p Q r s t u v >file &&
> > +             echo y | git -c diff.context=5 -c diff.interhunkcontext=1 \
> > +                     $cmd -p -U 4 --inter-hunk-context 2 >actual &&
> > +             test_grep "@@ -2,20 +2,20 @@" actual
> > +     '
> > +done
> > +
> > +test_expect_success 'reset accepts -U and --inter-hunk-context' '
> > +     test_write_lines a b c d e f g h i j k l m n o p q r s t u v >file &&
> > +     git commit -m file file &&
> > +     test_write_lines a b c d e F g h i j k l m n o p Q r s t u v >file &&
> >       git add file &&
> > -     test_write_lines a b c d e f G h i j k l m >file &&
> > -     echo y | git -c diff.context=5 add -p >actual &&
> > -     test_grep "@@ -2,11 +2,11 @@" actual
> > +     echo y | git -c diff.context=5 -c diff.interhunkcontext=1 \
> > +             reset -p -U 4 --inter-hunk-context 2 >actual &&
> > +     test_grep "@@ -2,20 +2,20 @@" actual
> >   '
> >
> > -test_expect_success 'add -p respects diff.interHunkContext' '
> > -     test_write_lines a b c d e f g h i j k l m n o p q r s >file &&
> > -     git add file &&
> > -     test_write_lines a b c d E f g i i j k l m N o p q r s >file &&
> > -     echo y | git -c diff.interhunkcontext=2 add -p >actual &&
> > -     test_grep "@@ -2,16 +2,16 @@" actual
>
> This is also deleting a test added in the last patch
>
> > +test_expect_success 'stash accepts -U and --inter-hunk-context' '
> > +     test_write_lines a b c d e F g h i j k l m n o p Q r s t u v >file &&
> > +     git commit -m file file &&
> > +     test_write_lines a b c d e f g h i j k l m n o p q r s t u v >file &&
> > +     echo y | git -c diff.context=5 -c diff.interhunkcontext=1 \
> > +             stash -p -U 4 --inter-hunk-context 2 >actual &&
> > +     test_grep "@@ -2,20 +2,20 @@" actual
> >   '
> >
> > -test_expect_success 'add -p rejects negative diff.context' '
> > -     test_config diff.context -1 &&
> > -     test_must_fail git add -p 2>output &&
> > -     test_grep "diff.context cannot be negative" output
> > -'
>
> and so is this. The tests you're adding look good but we shouldn't be
> deleting the existing ones.
>
> > +for cmd in add checkout commit reset restore "stash save" "stash push"
> > +do
> > +     test_expect_success "$cmd rejects invalid context options" '
> > +             test_must_fail git $cmd -p -U -3 2>actual &&
> > +             cat actual | echo &&
> > +             test_grep -e ".--unified. cannot be negative" actual &&
> > +
> > +             test_must_fail git $cmd -p --inter-hunk-context -3 2>actual &&
> > +             test_grep -e ".--inter-hunk-context. cannot be negative" actual &&
> > +
> > +             test_must_fail git $cmd -U 7 2>actual &&
> > +             test_grep -E ".--unified. requires .(--interactive/)?--patch." actual &&
> > +
> > +             test_must_fail git $cmd --inter-hunk-context 2 2>actual &&
> > +             test_grep -E ".--inter-hunk-context. requires .(--interactive/)?--patch." actual
> > +     '
> > +done
>
> This looks good as well
> >   test_done
> As I said last time I do not think the tests below add any value. They
> also do not compensate for the removal of the tests for diff.context
> that are deleted above as they all pass -U on the commandline.
>
> > diff --git a/t/t4055-diff-context.sh b/t/t4055-diff-context.sh
> > index 1384a8195705..0158fe6568cb 100755
> > --- a/t/t4055-diff-context.sh
> > +++ b/t/t4055-diff-context.sh
> > @@ -58,6 +58,36 @@ test_expect_success 'The -U option overrides diff.context' '
> >       test_grep ! "^ firstline" output
> >   '
> >
> > +test_expect_success 'The -U option overrides diff.context for "add"' '
> > +     test_config diff.context 8 &&
> > +     git add -U4 -p >output &&
> > +     test_grep ! "^ firstline" output
> > +'
> > +
> > +test_expect_success 'The -U option overrides diff.context for "commit"' '
> > +     test_config diff.context 8 &&
> > +     ! git commit -U4 -p >output &&
> > +     test_grep ! "^ firstline" output
> > +'
> > +
> > +test_expect_success 'The -U option overrides diff.context for "checkout"' '
> > +     test_config diff.context 8 &&
> > +     git checkout -U4 -p >output &&
> > +     test_grep ! "^ firstline" output
> > +'
> > +
> > +test_expect_success 'The -U option overrides diff.context for "stash"' '
> > +     test_config diff.context 8 &&
> > +     ! git stash -U4 -p >output &&
> > +     test_grep ! "^ firstline" output
> > +'
> > +
> > +test_expect_success 'The -U option overrides diff.context for "restore"' '
> > +     test_config diff.context 8 &&
> > +     git restore -U4 -p >output &&
> > +     test_grep ! "^ firstline" output
> > +'
> > +
> >   test_expect_success 'diff.context honored by "diff"' '
> >       test_config diff.context 8 &&
> >       git diff >output &&
>
> Thanks
>
> Phillip
>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Leon Michalak wrote (reply to this):

Apologies for the top-posting above, this is not my regular workflow!

Copy link

gitgitgadget bot commented Jul 22, 2025

On the Git mailing list, Phillip Wood wrote (reply to this):

On 21/07/2025 17:50, Junio C Hamano wrote:
> "Leon Michalak via GitGitGadget" <[email protected]> writes:
> >> Changes since v3:
>>
>>   * Update commit descriptions
>>   * Read struct properties directly instead of assigning to variables first
>>   * Simplify config setting / error checking
>>   * Remove redundant tests in later commit as they were replaced with better
>>     test(s)

I've left some comments on patch 4 about this. It seems to me that it is deleting useful tests and replacing them with redundant tests.

>>   * Change tests to use single quotes (this messes with the grep so was
>>     unable to explicitly test single quotes in the error messages, so decided
>>     to use regex . instead, which is what some other tests that have this
>>     problem seem to use as well)

Thanks for doing that

> > All of the above looked reasonably well done.  Will replace.
> > Unless there are objections, let me mark the topic for 'next' soonish.

I think we want to sort out the test changes in patch 4. Previously we discussed centralizing the option parsing in that patch as well but we can always do that as a follow up later.

Thanks

Phillip

Copy link

gitgitgadget bot commented Jul 22, 2025

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

Phillip Wood <[email protected]> writes:

>> All of the above looked reasonably well done.  Will replace.
>> Unless there are objections, let me mark the topic for 'next'
>> soonish.
>
> I think we want to sort out the test changes in patch 4. Previously we
> discussed centralizing the option parsing in that patch as well but we
> can always do that as a follow up later.

Yeah, the tests can probably use a bit more polish before we can
move forward.  Thanks for carefully reading them over.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants