How do I use a pager for long git add --patch hunks?
You can't. It's the nature of the Unix pipeline model.
The reason that Git commands that use pagers can work with any generic stdin
pager is because of this model. Such git commands write their output to stdout
. The pager reads its input from stdin
. The stdout
of the former is piped to the stdin
of the latter. It is precisely the simplicity of this pipeline model that makes pagers generic and allows git to allow you to choose your own pager, as long as it uses this model.
So why can't git add -p
(or git add -i
) do the same as git diff
or git log
?
Because there can only be one interactive app at a time.
git diff
and git log
are not interactive. git add -p
and pagers are interactive.
The nature of the pipeline model means that only one application can be in control at a time, and an interactive app needs to be in control. For the pager to gain control of the terminal (so that it can display prompts and respond to your input), git add -p
has to release control. Once it does it cannot get it back.
Look at it this way: There would be two command line prompts trying to interact with you: the one for git add -p
and the one for the pager. How would they coordinate? It would have to go something like this:
git add -p
writes a hunk tostdout
, along with an end-of-hunk (EOH) marker instead of the usual end-of-file (EOF) marker.git add -p
then yields control of the terminal to whatever app is at the other end of the pipe.- The pager would receive the hunk, and with control of the terminal displays pieces of the hunk along with its command prompts.
- The pager would behave like it usually does but with a big difference. Usually it sees an EOF marker, so when you say you're done (the
quit
command), it exits. But the EOH maker tells the pager, "Don't exit. When the user is done, hand control back to the upstream app. Do not quit. Wait." - So when you are done perusing the hunk with the various pager commands, you would use its
quit
command to tell it you're done like you usually do. - But now instead of exiting, the pager somehow hands terminal control back to
git add
. git add
's terminal prompt would then replace the pager's...- ...and now we're back to step 1. Keep repeating until EOF.
As you can see, not only is this a bad user experience (using the pager's quit
command to get back to git add
on each hunk), it would totally undermine destroy the power and beauty of the Unix pipeline model.
It is for this same reason that git add -p
cannot use diff-so-fancy
The only way for git -p
to have pager like behavior is to have one built-in, or to define a "Git Pager API" and then we wait for people to write pagers that work with this API. This is the plugin model, which is very different from the pipeline model. It also means a tight integration: The git add -p
commands and the pager commands would have to be combined and made available at each command prompt.
Use your terminal application's paging
I find it easy enough to scroll up in my terminal window. Mine has keyboard commands that allow me to move line by line or page by page.
Use git add -p
's split
command
Have you considered using git add -p
's split
command to break up the hunks? I find smaller hunks much easier to reason with anyway!
As a workaround you can set EDITOR=less
and use e
(edit
) to run less
on large hunks. But as-is that workaround has some disadvantages. Those can be avoided with something like this:
EDITOR="EDITOR='$EDITOR' bash -c 'set -m; less -K \"\$1\"' --" git add -p
Resetting
EDITOR
before invokingless
allows using the standardv
key inless
to invoke the editor.The
-K
option toless
allows quittingless
with Control-C, telling Git to not stage the hunk. Exitingless
withq
will cause the hunk to be staged.set -m
creates a separate process group which stops Control-C from bubbling up and killing the Git process.
There are also tools such as Magit that provide a better interface for interactive staging
Based on AtnNn's answer, I came up with the following alias:
ap = !"VISUAL=\"VISUAL='$VISUAL' bash -c 'set -m; less -K -+F \\\"\\$1\\\"' --\" git add -p \"$@\" #"
- Press
e
to page the hunk inless
- Press
q
to stage what was displayed - Press
v
to edit what is displayed - Press
^C
to quit and repeat the interactive menu
- Press
I'm working on a PR to fix this in git
itself.