Subject: [PATCH v2] git-p4.py: fix --prepare-p4-only error with multiple commits

From: "Ben Keene via GitGitGadget" <[email-masked]>
Date: Tue, 12 May 2020 13:15:59 +0000

From: Ben Keene <[email-masked]>

When using git p4 submit with the --prepare-p4-only option, the program
should prepare a single p4 changelist and notify the user that more
commits are pending and then stop processing.

A bug has been introduced by the p4-changelist hook feature that
causes the program to continue to try and process all pending
changelists at the same time.

The function applyCommit returns True when applying the commit
was successful and the program should continue. However, when the
optional flag --prepare-p4-only is set, the program should stop
after the first application.

Change the logic in the run method for P4Submit to check for the
flag --prepare-p4-only after successfully completing the applyCommit
method.

Be aware - this change will fix the existing test error in t9807.23
for --prepare-p4-only. However there is insufficent coverage for
this flag.  If more than 1 commit is pending submission to P4, the
method will properly prepare the P4 changelist, however it will
still exit the application with an exitcode of 1.

The current documentation does not define what the exit code should be
in this condition.
(See: https://git-scm.com/docs/git-p4#Documentation/git-p4.txt---prepare-p4-only)

Signed-off-by: Ben Keene <[email-masked]>
---
    git-p4.py: fix --prepare-p4-only error with multiple commits
    
    When using git p4 submit with the --prepare-p4-only option, the program
    should prepare a single p4 changelist and notify the user that more
    commits are pending and then stop processing.
    
    A bug has been introduced by the p4-changelist hook feature that causes
    the program to continue to try and process all pending changelists at
    the same time.
    
    The function applyCommit should return True when applying the commit was
    successful and the program should continue. In the case of the
    --prepare-p4-only flag, the function should return False, alerting the
    caller that the program should not proceed with additional commits.
    
    Change the return value from True to False in the applyCommit function
    when git-p4 is executed with --prepare-p4-only flag.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-775%2Fseraphire%2Fseraphire%2Fp4-hook-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-775/seraphire/seraphire/p4-hook-v2
Pull-Request: https://github.com/git/git/pull/775

Range-diff vs v1:

 1:  57a34af2b86 < -:  ----------- git-p4.py: fix --prepare-p4-only error with multiple commits
 -:  ----------- > 1:  a554a65503e git-p4.py: fix --prepare-p4-only error with multiple commits

 git-p4.py | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/git-p4.py b/git-p4.py
index b8b2a1679e7..c4a4012bcc1 100755
--- a/git-p4.py
+++ b/git-p4.py
@@ -2537,11 +2537,12 @@ def run(self, args):
                 ok = self.applyCommit(commit)
             if ok:
                 applied.append(commit)
-            else:
-                if self.prepare_p4_only and i < last:
-                    print("Processing only the first commit due to option" \
-                          " --prepare-p4-only")
+                if self.prepare_p4_only:
+                    if i < last:
+                        print("Processing only the first commit due to option" \
+                                " --prepare-p4-only")
                     break
+            else:
                 if i < last:
                     # prompt for what to do, or use the option/variable
                     if self.conflict_behavior == "ask":

base-commit: 07d8ea56f2ecb64b75b92264770c0a664231ce17
-- 
gitgitgadget