Skip to content

add -p: introduce 'w' command to view hunk with --word-diff#2289

Open
CrimsonGlory wants to merge 1 commit into
git:masterfrom
CrimsonGlory:add-p-word-diff
Open

add -p: introduce 'w' command to view hunk with --word-diff#2289
CrimsonGlory wants to merge 1 commit into
git:masterfrom
CrimsonGlory:add-p-word-diff

Conversation

@CrimsonGlory
Copy link
Copy Markdown

@CrimsonGlory CrimsonGlory commented May 6, 2026

No description provided.

@gitgitgadget-git
Copy link
Copy Markdown

gitgitgadget-git Bot commented May 6, 2026

Welcome to GitGitGadget

Hi @CrimsonGlory, 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:

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
Copy link
Copy Markdown
Member

dscho commented May 6, 2026

/allow

@gitgitgadget-git
Copy link
Copy Markdown

gitgitgadget-git Bot commented May 6, 2026

User CrimsonGlory is now allowed to use GitGitGadget.

WARNING: CrimsonGlory 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.

@dscho
Copy link
Copy Markdown
Member

dscho commented May 6, 2026

@CrimsonGlory this seems to need an update to the tests, as they are currently failing:

Failure log 
failed: t3701.51 print again the hunk (PAGER)
failure: t3701.51 print again the hunk (PAGER) 
  	test_when_finished "git reset" &&
  	cat >expect <<-EOF &&
  	<GREEN>+<RESET><GREEN>15<RESET>
  	 20<RESET>
  	<BOLD;BLUE>(1/2) Stage this hunk (was: y) [y,n,q,a,d,k,K,j,J,g,/,e,w,p,P,?]? <RESET>PAGER <CYAN>@@ -1,2 +1,3 @@<RESET>
  	PAGER  10<RESET>
  	PAGER <GREEN>+<RESET><GREEN>15<RESET>
  	PAGER  20<RESET>
  	<BOLD;BLUE>(1/2) Stage this hunk (was: y) [y,n,q,a,d,k,K,j,J,g,/,e,w,p,P,?]? <RESET>
  	EOF
  	test_write_lines s y g 1 P |
  	(
  		GIT_PAGER="sed s/^/PAGER\ /" &&
  		export GIT_PAGER &&
  		test_terminal git add -p >actual
  	) &&
  	tail -n 7 <actual | test_decode_color >actual.trimmed &&
  	test_cmp expect actual.trimmed
  
  checking prerequisite: TTY
  
  mkdir -p "$TRASH_DIRECTORY/prereq-test-dir-TTY" &&
  (
  	cd "$TRASH_DIRECTORY/prereq-test-dir-TTY" &&
  	test_have_prereq PERL &&
  
  	# Reading from the pty master seems to get stuck _sometimes_
  	# on Mac OS X 10.5.0, using Perl 5.10.0 or 5.8.9.
  	#
  	# Reproduction recipe: run
  	#
  	#	i=0
  	#	while ./test-terminal.perl echo hi $i
  	#	do
  	#		: $((i = $i + 1))
  	#	done
  	#
  	# After 2000 iterations or so it hangs.
  	# https://rt.cpan.org/Ticket/Display.html?id=65692
  	#
  	test "$(uname -s)" != Darwin &&
  
  	perl "$TEST_DIRECTORY"/test-terminal.perl \
  		sh -c "test -t 1 && test -t 2"
  
  )
  + mkdir -p /__w/git/git/t/trash directory.t3701-add-interactive/prereq-test-dir-TTY
  + cd /__w/git/git/t/trash directory.t3701-add-interactive/prereq-test-dir-TTY
  + test_have_prereq PERL
  + save_IFS= 	
  
  + IFS=,
  + set -- PERL
  + IFS= 	
  
  + total_prereq=0
  + ok_prereq=0
  + missing_prereq=
  + negative_prereq=
  + total_prereq=1
  + satisfied_this_prereq=t
  + ok_prereq=1
  + test 1 = 1
  + uname -s
  + test Linux != Darwin
  + perl /__w/git/git/t/test-terminal.perl sh -c test -t 1 && test -t 2
  + command /usr/bin/perl /__w/git/git/t/test-terminal.perl sh -c test -t 1 && test -t 2
  prerequisite TTY ok
  + test_when_finished git reset
  + test 0 = 0
  + test_cleanup={ git reset
  		} && (exit "$eval_ret"); eval_ret=$?; :
  + cat
  + test_write_lines s y g 1 P
  + printf %s\n s y g 1 P
  + GIT_PAGER=sed s/^/PAGER\ /
  + export GIT_PAGER
  + test_terminal git add -p
  + test_declared_prereq TTY
  + return 0
  + perl /__w/git/git/t/test-terminal.perl git add -p
  + command /usr/bin/perl /__w/git/git/t/test-terminal.perl git add -p
  + tail -n 7
  + test_decode_color
  + awk 
  		function name(n) {
  			if (n == 0) return "RESET";
  			if (n == 1) return "BOLD";
  			if (n == 2) return "FAINT";
  			if (n == 3) return "ITALIC";
  			if (n == 7) return "REVERSE";
  			if (n == 22) return "NORMAL_INTENSITY";
  			if (n == 23) return "NOITALIC";
  			if (n == 27) return "NOREVERSE";
  			if (n == 30) return "BLACK";
  			if (n == 31) return "RED";
  			if (n == 32) return "GREEN";
  			if (n == 33) return "YELLOW";
  			if (n == 34) return "BLUE";
  			if (n == 35) return "MAGENTA";
  			if (n == 36) return "CYAN";
  			if (n == 37) return "WHITE";
  			if (n == 40) return "BLACK";
  			if (n == 41) return "BRED";
  			if (n == 42) return "BGREEN";
  			if (n == 43) return "BYELLOW";
  			if (n == 44) return "BBLUE";
  			if (n == 45) return "BMAGENTA";
  			if (n == 46) return "BCYAN";
  			if (n == 47) return "BWHITE";
  		}
  		{
  			while (match($0, /\033\[[0-9;]*m/) != 0) {
  				printf "%s<", substr($0, 1, RSTART-1);
  				codes = substr($0, RSTART+2, RLENGTH-3);
  				if (length(codes) == 0)
  					printf "%s", name(0)
  				else {
  					n = split(codes, ary, ";");
  					sep = "";
  					for (i = 1; i <= n; i++) {
  						printf "%s%s", sep, name(ary[i]);
  						sep = ";"
  					}
  				}
  				printf ">";
  				$0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
  			}
  			print
  		}
  	
  + test_cmp expect actual.trimmed
  + test 2 -ne 2
  + eval diff -u "$@"
  + diff -u expect actual.trimmed
  --- expect	2026-05-06 02:04:45.516032580 +0000
  +++ actual.trimmed	2026-05-06 02:04:45.618032142 +0000
  @@ -1,7 +1 @@
  -<GREEN>+<RESET><GREEN>15<RESET>
  - 20<RESET>
  -<BOLD;BLUE>(1/2) Stage this hunk (was: y) [y,n,q,a,d,k,K,j,J,g,/,e,w,p,P,?]? <RESET>PAGER <CYAN>@@ -1,2 +1,3 @@<RESET>
  -PAGER  10<RESET>
  -PAGER <GREEN>+<RESET><GREEN>15<RESET>
  -PAGER  20<RESET>
  -<BOLD;BLUE>(1/2) Stage this hunk (was: y) [y,n,q,a,d,k,K,j,J,g,/,e,w,p,P,?]? <RESET>
  +<BOLD;RED>No changes.<RESET>
  error: last command exited with $?=1
  + git reset
  + exit 1
  + eval_ret=1
  + :
  not ok 51 - print again the hunk (PAGER)
  #	
  #		test_when_finished "git reset" &&
  #		cat >expect <<-EOF &&
  #		<GREEN>+<RESET><GREEN>15<RESET>
  #		 20<RESET>
  #		<BOLD;BLUE>(1/2) Stage this hunk (was: y) [y,n,q,a,d,k,K,j,J,g,/,e,w,p,P,?]? <RESET>PAGER <CYAN>@@ -1,2 +1,3 @@<RESET>
  #		PAGER  10<RESET>
  #		PAGER <GREEN>+<RESET><GREEN>15<RESET>
  #		PAGER  20<RESET>
  #		<BOLD;BLUE>(1/2) Stage this hunk (was: y) [y,n,q,a,d,k,K,j,J,g,/,e,w,p,P,?]? <RESET>
  #		EOF
  #		test_write_lines s y g 1 P |
  #		(
  #			GIT_PAGER="sed s/^/PAGER\ /" &&
  #			export GIT_PAGER &&
  #			test_terminal git add -p >actual
  #		) &&
  #		tail -n 7 <actual | test_decode_color >actual.trimmed &&
  #		test_cmp expect actual.trimmed
  #

For guidance how to replicate this locally, see e.g. here.

Note: It looks as if this failure is platform-dependent, seeing as it only happens in some Linux jobs, but not on Windows nor on macOS.

@CrimsonGlory
add -p: introduce 'w' command to view hunk with --word-diff
a496a89 
When using `git add --patch`, reviewing changes in long lines can be
difficult with the default line-based diff. This is particularly
noticeable in formats such as JSONP, CSV, LaTeX, Markdown, or other
plain text where small inline edits can be hard to spot.

Introduce a new interactive command `w` during hunk selection to
re-display the current hunk using `--word-diff`. This provides a
clearer, inline view of changes without affecting how patches are
applied or staged.

The command is intended as a read-only visualization aid. It does not
modify the hunk, nor does it change staging behavior, which remains
line-based.

Signed-off-by: CrimsonGlory <javierbassi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

new user

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@CrimsonGlory @dscho