add -p: show user's hunk decision when selecting hunks

When a user is interactively deciding which hunks to use or skip for
staging, unstaging, stashing etc, there is no way to know the
decision previously chosen for a hunk when navigating through the
previous and next hunks using K/J respectively.

Improve the UI to explicitly show if a user has previously decided to
use a hunk (by pressing 'y') or skip the hunk (by pressing 'n').
This will improve clarity and aid the navigation process for the
user.

Reported-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Abraham Samuel Adekunle <abrahamadekunle50@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/add-patch.c b/add-patch.c
index 173a53241ebf07b1cfde0988a4d3ac7330d22b6d..a383ea7f45492132967e25a41aeea4db9b373c7f 100644 (file)
--- a/add-patch.c
+++ b/add-patch.c
@@ -42,10 +42,10 @@ static struct patch_mode patch_mode_add = {
        .apply_args = { "--cached", NULL },
        .apply_check_args = { "--cached", NULL },
        .prompt_mode = {
-               N_("Stage mode change [y,n,q,a,d%s,?]? "),
-               N_("Stage deletion [y,n,q,a,d%s,?]? "),
-               N_("Stage addition [y,n,q,a,d%s,?]? "),
-               N_("Stage this hunk [y,n,q,a,d%s,?]? ")
+               N_("Stage mode change%s[y,n,q,a,d%s,?]? "),
+               N_("Stage deletion%s[y,n,q,a,d%s,?]? "),
+               N_("Stage addition%s[y,n,q,a,d%s,?]? "),
+               N_("Stage this hunk%s[y,n,q,a,d%s,?]? ")
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for staging."),
@@ -64,10 +64,10 @@ static struct patch_mode patch_mode_stash = {
        .apply_args = { "--cached", NULL },
        .apply_check_args = { "--cached", NULL },
        .prompt_mode = {
-               N_("Stash mode change [y,n,q,a,d%s,?]? "),
-               N_("Stash deletion [y,n,q,a,d%s,?]? "),
-               N_("Stash addition [y,n,q,a,d%s,?]? "),
-               N_("Stash this hunk [y,n,q,a,d%s,?]? "),
+               N_("Stash mode change%s[y,n,q,a,d%s,?]? "),
+               N_("Stash deletion%s[y,n,q,a,d%s,?]? "),
+               N_("Stash addition%s[y,n,q,a,d%s,?]? "),
+               N_("Stash this hunk%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for stashing."),
@@ -88,10 +88,10 @@ static struct patch_mode patch_mode_reset_head = {
        .is_reverse = 1,
        .index_only = 1,
        .prompt_mode = {
-               N_("Unstage mode change [y,n,q,a,d%s,?]? "),
-               N_("Unstage deletion [y,n,q,a,d%s,?]? "),
-               N_("Unstage addition [y,n,q,a,d%s,?]? "),
-               N_("Unstage this hunk [y,n,q,a,d%s,?]? "),
+               N_("Unstage mode change%s[y,n,q,a,d%s,?]? "),
+               N_("Unstage deletion%s[y,n,q,a,d%s,?]? "),
+               N_("Unstage addition%s[y,n,q,a,d%s,?]? "),
+               N_("Unstage this hunk%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for unstaging."),
@@ -111,10 +111,10 @@ static struct patch_mode patch_mode_reset_nothead = {
        .apply_check_args = { "--cached", NULL },
        .index_only = 1,
        .prompt_mode = {
-               N_("Apply mode change to index [y,n,q,a,d%s,?]? "),
-               N_("Apply deletion to index [y,n,q,a,d%s,?]? "),
-               N_("Apply addition to index [y,n,q,a,d%s,?]? "),
-               N_("Apply this hunk to index [y,n,q,a,d%s,?]? "),
+               N_("Apply mode change to index%s[y,n,q,a,d%s,?]? "),
+               N_("Apply deletion to index%s[y,n,q,a,d%s,?]? "),
+               N_("Apply addition to index%s[y,n,q,a,d%s,?]? "),
+               N_("Apply this hunk to index%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for applying."),
@@ -134,10 +134,10 @@ static struct patch_mode patch_mode_checkout_index = {
        .apply_check_args = { "-R", NULL },
        .is_reverse = 1,
        .prompt_mode = {
-               N_("Discard mode change from worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard deletion from worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard addition from worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard this hunk from worktree [y,n,q,a,d%s,?]? "),
+               N_("Discard mode change from worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard deletion from worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard addition from worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard this hunk from worktree%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for discarding."),
@@ -157,10 +157,10 @@ static struct patch_mode patch_mode_checkout_head = {
        .apply_check_args = { "-R", NULL },
        .is_reverse = 1,
        .prompt_mode = {
-               N_("Discard mode change from index and worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard deletion from index and worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard addition from index and worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard this hunk from index and worktree [y,n,q,a,d%s,?]? "),
+               N_("Discard mode change from index and worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard deletion from index and worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard addition from index and worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard this hunk from index and worktree%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for discarding."),
@@ -179,10 +179,10 @@ static struct patch_mode patch_mode_checkout_nothead = {
        .apply_for_checkout = 1,
        .apply_check_args = { NULL },
        .prompt_mode = {
-               N_("Apply mode change to index and worktree [y,n,q,a,d%s,?]? "),
-               N_("Apply deletion to index and worktree [y,n,q,a,d%s,?]? "),
-               N_("Apply addition to index and worktree [y,n,q,a,d%s,?]? "),
-               N_("Apply this hunk to index and worktree [y,n,q,a,d%s,?]? "),
+               N_("Apply mode change to index and worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Apply deletion to index and worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Apply addition to index and worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Apply this hunk to index and worktree%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for applying."),
@@ -202,10 +202,10 @@ static struct patch_mode patch_mode_worktree_head = {
        .apply_check_args = { "-R", NULL },
        .is_reverse = 1,
        .prompt_mode = {
-               N_("Discard mode change from worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard deletion from worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard addition from worktree [y,n,q,a,d%s,?]? "),
-               N_("Discard this hunk from worktree [y,n,q,a,d%s,?]? "),
+               N_("Discard mode change from worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard deletion from worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard addition from worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Discard this hunk from worktree%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for discarding."),
@@ -224,10 +224,10 @@ static struct patch_mode patch_mode_worktree_nothead = {
        .apply_args = { NULL },
        .apply_check_args = { NULL },
        .prompt_mode = {
-               N_("Apply mode change to worktree [y,n,q,a,d%s,?]? "),
-               N_("Apply deletion to worktree [y,n,q,a,d%s,?]? "),
-               N_("Apply addition to worktree [y,n,q,a,d%s,?]? "),
-               N_("Apply this hunk to worktree [y,n,q,a,d%s,?]? "),
+               N_("Apply mode change to worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Apply deletion to worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Apply addition to worktree%s[y,n,q,a,d%s,?]? "),
+               N_("Apply this hunk to worktree%s[y,n,q,a,d%s,?]? "),
        },
        .edit_hunk_hint = N_("If the patch applies cleanly, the edited hunk "
                             "will immediately be marked for applying."),
@@ -1460,6 +1460,7 @@ static int patch_update_file(struct add_p_state *s,
        render_diff_header(s, file_diff, colored, &s->buf);
        fputs(s->buf.buf, stdout);
        for (;;) {
+               const char *hunk_use_decision = " ";
                enum {
                        ALLOW_GOTO_PREVIOUS_HUNK = 1 << 0,
                        ALLOW_GOTO_PREVIOUS_UNDECIDED_HUNK = 1 << 1,
@@ -1564,8 +1565,14 @@ static int patch_update_file(struct add_p_state *s,
                              (uintmax_t)(file_diff->hunk_nr
                                                ? file_diff->hunk_nr
                                                : 1));
+               if (file_diff->hunk_nr && hunk->use != UNDECIDED_HUNK) {
+                       if (hunk->use == USE_HUNK)
+                               hunk_use_decision = _(" (previous decision: use) ");
+                       else
+                               hunk_use_decision = _(" (previous decision: skip) ");
+               }
                printf(_(s->mode->prompt_mode[prompt_mode_type]),
-                      s->buf.buf);
+                       hunk_use_decision, s->buf.buf);
                if (*s->s.reset_color_interactive)
                        fputs(s->s.reset_color_interactive, stdout);
                fflush(stdout);

diff --git a/t/t3701-add-interactive.sh b/t/t3701-add-interactive.sh
index 4285314f35f8f20ec724c251928d1087e5c626b8..cc3986a9d7e7df639bfbac98c0b2f6ccd4102ac6 100755 (executable)
--- a/t/t3701-add-interactive.sh
+++ b/t/t3701-add-interactive.sh
@@ -527,7 +527,7 @@ test_expect_success 'goto hunk 1 with "g 1"' '
        _10
        +15
        _20
-       (1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
+       (1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
        EOF
        test_write_lines s y g 1 | git add -p >actual &&
        tail -n 7 <actual >actual.trimmed &&
@@ -540,7 +540,7 @@ test_expect_success 'goto hunk 1 with "g1"' '
        _10
        +15
        _20
-       (1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
+       (1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
        EOF
        test_write_lines s y g1 | git add -p >actual &&
        tail -n 4 <actual >actual.trimmed &&
@@ -554,7 +554,7 @@ test_expect_success 'navigate to hunk via regex /pattern' '
        _10
        +15
        _20
-       (1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
+       (1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
        EOF
        test_write_lines s y /1,2 | git add -p >actual &&
        tail -n 5 <actual >actual.trimmed &&
@@ -567,7 +567,7 @@ test_expect_success 'navigate to hunk via regex / pattern' '
        _10
        +15
        _20
-       (1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
+       (1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
        EOF
        test_write_lines s y / 1,2 | git add -p >actual &&
        tail -n 4 <actual >actual.trimmed &&
@@ -579,11 +579,11 @@ test_expect_success 'print again the hunk' '
        tr _ " " >expect <<-EOF &&
        +15
         20
-       (1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]? @@ -1,2 +1,3 @@
+       (1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]? @@ -1,2 +1,3 @@
         10
        +15
         20
-       (1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
+       (1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]?_
        EOF
        test_write_lines s y g 1 p | git add -p >actual &&
        tail -n 7 <actual >actual.trimmed &&
@@ -595,11 +595,11 @@ test_expect_success TTY 'print again the hunk (PAGER)' '
        cat >expect <<-EOF &&
        <GREEN>+<RESET><GREEN>15<RESET>
         20<RESET>
-       <BOLD;BLUE>(1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]? <RESET>PAGER <CYAN>@@ -1,2 +1,3 @@<RESET>
+       <BOLD;BLUE>(1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,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 [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]? <RESET>
+       <BOLD;BLUE>(1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]? <RESET>
        EOF
        test_write_lines s y g 1 P |
        (
@@ -810,7 +810,7 @@ test_expect_success 'colors can be overridden' '
        <BOLD>-old<RESET>
        <BLUE>+new<RESET>
        <CYAN> more-context<RESET>
-       <YELLOW>(1/2) Stage this hunk [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]? <RESET>
+       <YELLOW>(1/2) Stage this hunk (previous decision: use) [y,n,q,a,d,k,K,j,J,g,/,e,p,P,?]? <RESET>
        EOF
        test_cmp expect actual
 '