From: ZheNing Hu <adlternative@xxxxxxxxx>
In the past, git cherry-pick would print such advice when
there was a conflict:
hint: after resolving the conflicts, mark the corrected paths
hint: with 'git add <paths>' or 'git rm <paths>'
hint: and commit the result with 'git commit'
But in fact, when we want to cherry-pick multiple commits,
we should not use "git commit" after resolving conflicts, which
will make Git generate some errors. We should recommend users to
use `git cherry-pick --continue`, `git cherry-pick --abort`, just
like git rebase does.
This is the improved advice:
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit: run "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
It is worth mentioning that now we use advice() to print the content
of GIT_CHERRY_PICK_HELP in print_advice(), each line of output will
start with "hint: ".
Mentored-by: Christian Couder <christian.couder@xxxxxxxxx>
Mentored-by Hariom Verma <hariom18599@xxxxxxxxx>:
Helped-by: Phillip Wood <phillip.wood@xxxxxxxxxxxxx>
Hepled-by: Junio C Hamano <gitster@xxxxxxxxx>
Signed-off-by: ZheNing Hu <adlternative@xxxxxxxxx>
---
[GSOC] cherry-pick: use better advice message
Because git cherry-pick's past advice message is not good enough, it
often misleads new users of Git, so this patch makes git chery-pick
advice message better.
v5:
https://lore.kernel.org/git/pull.1010.git.1627714877.gitgitgadget@xxxxxxxxx/
v5-->v6:
1. Deleted the first patch, which could have made git cherry-pick not
delete CHERRY_PICK_HEAD when using GIT_CHERRY_PICK_HELP, but both
Junio and Phillip believe that this design does not need to be
changed.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1010%2Fadlternative%2Fcherry-pick-help-fix-3-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1010/adlternative/cherry-pick-help-fix-3-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1010
Range-diff vs v2:
1: 5d2fd55c580 < -: ----------- [GSOC] cherry-pick: fix bug when used with GIT_CHERRY_PICK_HELP
2: 5279bca7a79 ! 1: 701645dde17 [GSOC] cherry-pick: use better advice message
@@ Commit message
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
+ It is worth mentioning that now we use advice() to print the content
+ of GIT_CHERRY_PICK_HELP in print_advice(), each line of output will
+ start with "hint: ".
+
Mentored-by: Christian Couder <christian.couder@xxxxxxxxx>
Mentored-by Hariom Verma <hariom18599@xxxxxxxxx>:
Helped-by: Phillip Wood <phillip.wood@xxxxxxxxxxxxx>
@@ Commit message
Signed-off-by: ZheNing Hu <adlternative@xxxxxxxxx>
## sequencer.c ##
-@@ sequencer.c: static void print_advice(struct replay_opts *opts, int show_hint)
+@@ sequencer.c: static void print_advice(struct repository *r, int show_hint,
+ char *msg = getenv("GIT_CHERRY_PICK_HELP");
+
if (msg) {
- advise("%s\n", msg);
- } else if (show_hint) {
+- fprintf(stderr, "%s\n", msg);
++ advise("%s\n", msg);
+ /*
+ * A conflict has occurred but the porcelain
+ * (typically rebase --interactive) wants to take care
+@@ sequencer.c: static void print_advice(struct repository *r, int show_hint,
+ }
+
+ if (show_hint) {
- if (opts->no_commit)
+ if (opts->action == REPLAY_PICK) {
+ advise(_("Resolve all conflicts manually, mark them as resolved with\n"
@@ sequencer.c: static void print_advice(struct replay_opts *opts, int show_hint)
+ "You can instead skip this commit: run \"git cherry-pick --skip\".\n"
+ "To abort and get back to the state before \"git cherry-pick\",\n"
+ "run \"git cherry-pick --abort\"."));
-+
+ } else if (opts->no_commit)
advise(_("after resolving the conflicts, mark the corrected paths\n"
"with 'git add <paths>' or 'git rm <paths>'"));
sequencer.c | 11 +++++++++--
t/t3507-cherry-pick-conflict.sh | 17 ++++++++++++-----
2 files changed, 21 insertions(+), 7 deletions(-)
diff --git a/sequencer.c b/sequencer.c
index 0bec01cf38e..7fa91b99870 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -403,7 +403,7 @@ static void print_advice(struct repository *r, int show_hint,
char *msg = getenv("GIT_CHERRY_PICK_HELP");
if (msg) {
- fprintf(stderr, "%s\n", msg);
+ advise("%s\n", msg);
/*
* A conflict has occurred but the porcelain
* (typically rebase --interactive) wants to take care
@@ -415,7 +415,14 @@ static void print_advice(struct repository *r, int show_hint,
}
if (show_hint) {
- if (opts->no_commit)
+ if (opts->action == REPLAY_PICK) {
+ advise(_("Resolve all conflicts manually, mark them as resolved with\n"
+ "\"git add/rm <conflicted_files>\", then run\n"
+ "\"git cherry-pick --continue\".\n"
+ "You can instead skip this commit: run \"git cherry-pick --skip\".\n"
+ "To abort and get back to the state before \"git cherry-pick\",\n"
+ "run \"git cherry-pick --abort\"."));
+ } else if (opts->no_commit)
advise(_("after resolving the conflicts, mark the corrected paths\n"
"with 'git add <paths>' or 'git rm <paths>'"));
else
diff --git a/t/t3507-cherry-pick-conflict.sh b/t/t3507-cherry-pick-conflict.sh
index 014001b8f32..d3ed9d7ce0d 100755
--- a/t/t3507-cherry-pick-conflict.sh
+++ b/t/t3507-cherry-pick-conflict.sh
@@ -53,9 +53,12 @@ test_expect_success 'advice from failed cherry-pick' "
picked=\$(git rev-parse --short picked) &&
cat <<-EOF >expected &&
error: could not apply \$picked... picked
- hint: after resolving the conflicts, mark the corrected paths
- hint: with 'git add <paths>' or 'git rm <paths>'
- hint: and commit the result with 'git commit'
+ hint: Resolve all conflicts manually, mark them as resolved with
+ hint: \"git add/rm <conflicted_files>\", then run
+ hint: \"git cherry-pick --continue\".
+ hint: You can instead skip this commit: run \"git cherry-pick --skip\".
+ hint: To abort and get back to the state before \"git cherry-pick\",
+ hint: run \"git cherry-pick --abort\".
EOF
test_must_fail git cherry-pick picked 2>actual &&
@@ -68,8 +71,12 @@ test_expect_success 'advice from failed cherry-pick --no-commit' "
picked=\$(git rev-parse --short picked) &&
cat <<-EOF >expected &&
error: could not apply \$picked... picked
- hint: after resolving the conflicts, mark the corrected paths
- hint: with 'git add <paths>' or 'git rm <paths>'
+ hint: Resolve all conflicts manually, mark them as resolved with
+ hint: \"git add/rm <conflicted_files>\", then run
+ hint: \"git cherry-pick --continue\".
+ hint: You can instead skip this commit: run \"git cherry-pick --skip\".
+ hint: To abort and get back to the state before \"git cherry-pick\",
+ hint: run \"git cherry-pick --abort\".
EOF
test_must_fail git cherry-pick --no-commit picked 2>actual &&
base-commit: daab8a564f8bbac55f70f8bf86c070e001a9b006
--
gitgitgadget
