From mboxrd@z Thu Jan 1 00:00:00 1970 From: Kong Lucien Subject: [PATCHv4 1/3] wt-status.*: better advices for git status added Date: Wed, 30 May 2012 15:23:34 +0200 Message-ID: <1338384216-18782-1-git-send-email-Lucien.Kong@ensimag.imag.fr> References: <1338226598-16056-1-git-send-email-Lucien.Kong@ensimag.imag.fr> Cc: Matthieu.Moy@grenoble-inp.fr, Kong Lucien , Duperray Valentin , Jonas Franck , Nguy Thomas , Nguyen Huynh Khoi Nguyen Lucien To: git@vger.kernel.org X-From: git-owner@vger.kernel.org Wed May 30 16:51:49 2012 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1SZkFQ-0001Bg-DI for gcvg-git-2@plane.gmane.org; Wed, 30 May 2012 16:51:41 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1757186Ab2E3Ovf (ORCPT ); Wed, 30 May 2012 10:51:35 -0400 Received: from mx2.imag.fr ([129.88.30.17]:54187 "EHLO rominette.imag.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755413Ab2E3Ove (ORCPT ); Wed, 30 May 2012 10:51:34 -0400 Received: from ensimag.imag.fr (ensimag.imag.fr [195.221.228.12]) by rominette.imag.fr (8.13.8/8.13.8) with ESMTP id q4UDFDx2024400 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Wed, 30 May 2012 15:15:14 +0200 Received: from ensibm.imag.fr (ensibm [195.221.228.8]) by ensimag.imag.fr (8.13.8/8.13.8/ImagV2.1.r_ens) with ESMTP id q4UDNbj5012288; Wed, 30 May 2012 15:23:37 +0200 Received: from ensibm.imag.fr (localhost [127.0.0.1]) by ensibm.imag.fr (8.13.8/8.13.8/ImagV2.1.sb_ens.pm) with ESMTP id q4UDNbcp019020; Wed, 30 May 2012 15:23:37 +0200 Received: (from konglu@localhost) by ensibm.imag.fr (8.13.8/8.13.8/Submit) id q4UDNass019017; Wed, 30 May 2012 15:23:36 +0200 X-Mailer: git-send-email 1.7.8 In-Reply-To: <1338226598-16056-1-git-send-email-Lucien.Kong@ensimag.imag.fr> X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.2.2 (rominette.imag.fr [129.88.30.17]); Wed, 30 May 2012 15:15:14 +0200 (CEST) X-IMAG-MailScanner-Information: Please contact MI2S MIM for more information X-MailScanner-ID: q4UDFDx2024400 X-IMAG-MailScanner: Found to be clean X-IMAG-MailScanner-SpamCheck: X-IMAG-MailScanner-From: lucien.kong@phelma.grenoble-inp.fr MailScanner-NULL-Check: 1338988515.01396@dzFQP7+eBdpCSIlOheoYLA Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: This patch provides new warning messages in the display of 'git status' (at the top) during conflicts, rebase, am, bisect or cherry-pick process. The new messages are not shown when using options such as -s or --porcelain.The messages about the current situation of the user are always displayed but the advices on what the user needs to do in order to resume a rebase/bisect /am/ commit after resolving conflicts can be hidden by setting advice.statushelp to 'false' in the config file. Thus, information about the new advice.* key are added in Documentation/config.txt. Also, the test t7060-wt-status.sh is now working with the new warning messages. Signed-off-by: Kong Lucien Signed-off-by: Duperray Valentin Signed-off-by: Jonas Franck Signed-off-by: Nguy Thomas Signed-off-by: Nguyen Huynh Khoi Nguyen Lucien --- The code figures the current state by finding the files generated in .git in each cases (during an am, a rebase, a bisect, etc.). The function wt_status_print_in_progress is now splitted into several smaller functions in order to avoid too many indentations. Documentation/config.txt | 4 + advice.c | 2 + advice.h | 1 + t/t7060-wtstatus.sh | 2 + wt-status.c | 161 ++++++++++++++++++++++++++++++++++++++++++++++ wt-status.h | 11 +++ 6 files changed, 181 insertions(+), 0 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 915cb5a..ab1c455 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -162,6 +162,9 @@ advice.*:: Directions on how to stage/unstage/add shown in the output of linkgit:git-status[1] and the template shown when writing commit messages. + statusHelp:: + Directions on how to end the current process shown + in the output of linkgit:git-status[1]. commitBeforeMerge:: Advice shown when linkgit:git-merge[1] refuses to merge to avoid overwriting local changes. @@ -176,6 +179,7 @@ advice.*:: Advice shown when you used linkgit:git-checkout[1] to move to the detach HEAD state, to instruct how to create a local branch after the fact. + -- core.fileMode:: diff --git a/advice.c b/advice.c index a492eea..31deb31 100644 --- a/advice.c +++ b/advice.c @@ -9,6 +9,7 @@ int advice_commit_before_merge = 1; int advice_resolve_conflict = 1; int advice_implicit_identity = 1; int advice_detached_head = 1; +int advice_status_help = 1; static struct { const char *name; @@ -23,6 +24,7 @@ static struct { { "resolveconflict", &advice_resolve_conflict }, { "implicitidentity", &advice_implicit_identity }, { "detachedhead", &advice_detached_head }, + { "statushelp", &advice_status_help }, }; void advise(const char *advice, ...) diff --git a/advice.h b/advice.h index f3cdbbf..5fd3cce 100644 --- a/advice.h +++ b/advice.h @@ -12,6 +12,7 @@ extern int advice_commit_before_merge; extern int advice_resolve_conflict; extern int advice_implicit_identity; extern int advice_detached_head; +extern int advice_status_help; int git_default_advice_config(const char *var, const char *value); void advise(const char *advice, ...); diff --git a/t/t7060-wtstatus.sh b/t/t7060-wtstatus.sh index b8cb490..d0fbcc7 100755 --- a/t/t7060-wtstatus.sh +++ b/t/t7060-wtstatus.sh @@ -30,6 +30,8 @@ test_expect_success 'Report new path with conflict' ' cat >expect <..." as appropriate to mark resolution) # diff --git a/wt-status.c b/wt-status.c index dd6d8c4..4dd294f 100644 --- a/wt-status.c +++ b/wt-status.c @@ -23,6 +23,7 @@ static char default_wt_status_colors[][COLOR_MAXLEN] = { GIT_COLOR_GREEN, /* WT_STATUS_LOCAL_BRANCH */ GIT_COLOR_RED, /* WT_STATUS_REMOTE_BRANCH */ GIT_COLOR_NIL, /* WT_STATUS_ONBRANCH */ + GIT_COLOR_NORMAL, /* WT_STATUS_IN_PROGRESS */ }; static const char *color(int slot, struct wt_status *s) @@ -728,10 +729,149 @@ static void wt_status_print_tracking(struct wt_status *s) color_fprintf_ln(s->fp, color(WT_STATUS_HEADER, s), "#"); } +static int wt_status_unmerged_present (struct wt_status *s) +{ + int i; + + for (i = 0; i < s->change.nr; i++) { + struct wt_status_change_data *d; + d = s->change.items[i].util; + if (d->stagemask) { + return 1; + } + } + return 0; +} + +static void wt_status_evaluate_state (struct wt_status_state *state) +{ + struct stat st; + + state->merge_in_progress = 0; + state->am_in_progress = 0; + state->am_empty_patch = 0; + state->rebase_in_progress = 0; + state->rebase_interactive_in_progress = 0; + state->cherry_pick_in_progress = 0; + state->bisect_in_progress = 0; + + if (!stat(git_path("MERGE_HEAD"), &st)) + state->merge_in_progress = 1; + else if (!stat(git_path("rebase-apply"), &st)) { + if (!stat(git_path("rebase-apply/applying"), &st)) { + state->am_in_progress = 1; + if (!stat(git_path("rebase-apply/patch"), &st) && !(st.st_size)) + state->am_empty_patch = 1; + } + else + state->rebase_in_progress = 1; + } + else if (!stat(git_path("rebase-merge"), &st)) { + if (!stat(git_path("rebase-merge/interactive"), &st)) + state->rebase_interactive_in_progress = 1; + else + state->rebase_in_progress = 1; + } + else if (!stat(git_path("CHERRY_PICK_HEAD"), &st)) + state->cherry_pick_in_progress = 1; + if (!stat(git_path("BISECT_LOG"), &st)) + state->bisect_in_progress = 1; +} + +static void wt_status_merge_in_progress (struct wt_status *s, + struct wt_status_state *state, + const char *color) +{ + if (wt_status_unmerged_present(s)) + status_printf_ln(s, color, + _("You have unmerged paths; fix conflicts and run \"git commit\".")); + else + status_printf_ln(s, color, + _("You are still merging, run \"git commit\" to conclude merge.")); + wt_status_print_trailer(s); +} + +static void wt_status_am_in_progress (struct wt_status *s, + struct wt_status_state *state, + const char *color) +{ + status_printf_ln(s, color, + _("You are currently in am progress:")); + if (state->am_empty_patch) + status_printf_ln(s, color, + _("One of the patches is empty!")); + if (advice_status_help) { + status_printf_ln(s, color, + _(" When you have resolved this problem run \"git am --resolved\".")); + status_printf_ln(s, color, + _(" If you would prefer to skip this patch, instead run \"git am --skip\".")); + status_printf_ln(s, color, + _(" To restore the original branch and stop patching run \"git am --abort\".")); + } + wt_status_print_trailer(s); +} + +static void wt_status_rebase_in_progress (struct wt_status *s, + struct wt_status_state *state, + const char *color) +{ + if (wt_status_unmerged_present(s)) { + status_printf_ln(s, color, _("You are currently rebasing%s"), + advice_status_help + ? _(": fix conflicts and then run \"git rebase --continue\".") : "."); + if (advice_status_help) { + status_printf_ln(s, color, + _(" If you would prefer to skip this patch, instead run \"git rebase --skip\".")); + status_printf_ln(s, color, + _(" To check out the original branch and stop rebasing run \"git rebase --abort\".")); + } + } + else if (state->rebase_in_progress) + status_printf_ln(s, color, _("You are currently rebasing: all conflicts fixed%s"), + advice_status_help + ? _(": run \"git rebase --continue\".") : "."); + else { + status_printf_ln(s, color, _("You are currently editing a commit during a rebase.")); + if (advice_status_help) { + status_printf_ln(s, color, _(" You can amend the commit with")); + status_printf_ln(s, color, _(" git commit --amend")); + status_printf_ln(s, color, _(" Once you are satisfied with your changes, run")); + status_printf_ln(s, color, _(" git rebase --continue")); + } + } + wt_status_print_trailer(s); +} + +static void wt_status_cherry_pick_in_progress (struct wt_status *s, + struct wt_status_state *state, + const char *color) +{ + if (wt_status_unmerged_present(s)) + status_printf_ln(s, color, + _("You are currently cherry-picking: fix conflicts and run \"git commit\".")); + else + status_printf_ln(s, color, + _("You are currently cherry-picking: all conflicts fixed: run \"git commit\".")); + wt_status_print_trailer(s); +} + +static void wt_status_bisect_in_progress (struct wt_status *s, + struct wt_status_state *state, + const char *color) +{ + status_printf_ln(s, color, _("You are currently bisecting.")); + if (advice_status_help) + status_printf_ln(s, color, + _(" To get back to the original branch run \"git bisect reset\"")); + wt_status_print_trailer(s); +} + void wt_status_print(struct wt_status *s) { const char *branch_color = color(WT_STATUS_ONBRANCH, s); const char *branch_status_color = color(WT_STATUS_HEADER, s); + const char *state_color = color(WT_STATUS_IN_PROGRESS, s); + struct wt_status_state *state = calloc(1, sizeof(*state)); if (s->branch) { const char *on_what = _("On branch "); @@ -750,6 +890,27 @@ void wt_status_print(struct wt_status *s) wt_status_print_tracking(s); } + wt_status_evaluate_state(state); + + if (state->merge_in_progress) { + wt_status_merge_in_progress(s, state, state_color); + } + else if (state->am_in_progress) { + wt_status_am_in_progress(s, state, state_color); + } + + else if (state->rebase_in_progress || state->rebase_interactive_in_progress) { + wt_status_rebase_in_progress(s, state, state_color); + } + + else if (state->cherry_pick_in_progress) { + wt_status_cherry_pick_in_progress(s, state, state_color); + } + + if (state->bisect_in_progress) { + wt_status_bisect_in_progress(s, state, state_color); + } + if (s->is_initial) { status_printf_ln(s, color(WT_STATUS_HEADER, s), ""); status_printf_ln(s, color(WT_STATUS_HEADER, s), _("Initial commit")); diff --git a/wt-status.h b/wt-status.h index 14aa9f7..c1066a0 100644 --- a/wt-status.h +++ b/wt-status.h @@ -15,6 +15,7 @@ enum color_wt_status { WT_STATUS_LOCAL_BRANCH, WT_STATUS_REMOTE_BRANCH, WT_STATUS_ONBRANCH, + WT_STATUS_IN_PROGRESS, WT_STATUS_MAXSLOT }; @@ -71,6 +72,16 @@ struct wt_status { struct string_list ignored; }; +struct wt_status_state { + int merge_in_progress; + int am_in_progress; + int am_empty_patch; + int rebase_in_progress; + int rebase_interactive_in_progress; + int cherry_pick_in_progress; + int bisect_in_progress; +}; + void wt_status_prepare(struct wt_status *s); void wt_status_print(struct wt_status *s); void wt_status_collect(struct wt_status *s); -- 1.7.8