Better support for customising context lines in --patch commands
#1915
Conversation
Welcome to GitGitGadgetHi @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:
You can CC potential reviewers by adding a footer to the PR description with the following syntax: NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description, 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:
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 patchesBefore 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 Both the person who commented An alternative is the channel Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment If you want to see what email(s) would be sent for a 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 curl -g --user "<EMailAddress>:<Password>" \
--url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txtTo 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): To send a new iteration, just add another PR comment with the contents: 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, |
NinjaInShade
force-pushed
the
interactive-patch-context
branch
2 times, most recently
from
0484407 to
ff64c39
Compare
|
/allow |
|
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
changed the title
--patch commands--patch commands
NinjaInShade
force-pushed
the
interactive-patch-context
branch
2 times, most recently
from
9b90dc6 to
b4b7854
Compare
|
/submit |
|
Submitted as [email protected] To fetch this version into To fetch this version to local tag |
![gitgitgadget[bot]](https://avatars.githubusercontent.com/in/12836?s=60&v=4){kind=small}
|
User |
|
User |
|
Thanks for letting me know, I'll make sure to amend that in v2 :)
…On Mon, 5 May 2025 at 21:33, gitgitgadget[bot] ***@***.***> wrote:
*gitgitgadget[bot]* left a comment (gitgitgadget/git#1915)
<#1915 (comment)>
User Eric Sunshine ***@***.***> has been added to the cc:
list.
—
Reply to this email directly, view it on GitHub
<#1915 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/APFXCEW367PGDBXHMJDZTHT247DJ7AVCNFSM6AAAAAB4M4W3LOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQNJSGI3DIOBUGQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
User |
|
User |
NinjaInShade
force-pushed
the
interactive-patch-context
branch
from
b4b7854 to
cf726da
Compare
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]>
Refactor to 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. This patch fixes this inconsistency. 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
force-pushed
the
interactive-patch-context
branch
from
cf726da to
973dfad
Compare
|
/submit |
|
Submitted as [email protected] To fetch this version into To fetch this version to local tag |
| @@ -63,7 +63,7 @@ test_expect_success 'setup (initial)' ' | |||
| ' | |||
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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>`:: | |||
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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.
|
This patch series was integrated into seen via git@0945e76. |
|
This patch series was integrated into seen via git@3512d8e. |
|
This patch series was integrated into seen via git@d808817. |
This series of patches attempt to give
--interactive/--patchcompatible 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
--patchcommands (apart from one workaround by usingGIT_DIFF_OPTS=-u<number> ..., however this isn't a good user experience or a persistent solution). Additionally, the behaviour around reading from thediff.contextanddiff.interHunkContextconfigs 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.contextanddiff.interHunkContextconfigs are now respected by--patchcompatible commands--unifiedand--inter-hunk-contextcommand line options have been added to--patchcompatible commands (which take prescendence over file configs)--interactivemode 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:
test_grepandtest_configutilscc: "Kristoffer Haugsbakk" [email protected]
cc: Eric Sunshine [email protected]
cc: Christian Couder [email protected]
cc: Phillip Wood [email protected]