advice.c

   1 #include "cache.h"
   2 #include "config.h"
   3 #include "color.h"
   4 #include "help.h"
   5
   6 int advice_fetch_show_forced_updates = 1;
   7 int advice_push_update_rejected = 1;
   8 int advice_push_non_ff_current = 1;
   9 int advice_push_non_ff_matching = 1;
  10 int advice_push_already_exists = 1;
  11 int advice_push_fetch_first = 1;
  12 int advice_push_needs_force = 1;
  13 int advice_push_unqualified_ref_name = 1;
  14 int advice_status_hints = 1;
  15 int advice_status_u_option = 1;
  16 int advice_status_ahead_behind_warning = 1;
  17 int advice_commit_before_merge = 1;
  18 int advice_reset_quiet_warning = 1;
  19 int advice_resolve_conflict = 1;
  20 int advice_sequencer_in_use = 1;
  21 int advice_implicit_identity = 1;
  22 int advice_detached_head = 1;
  23 int advice_set_upstream_failure = 1;
  24 int advice_object_name_warning = 1;
  25 int advice_amworkdir = 1;
  26 int advice_rm_hints = 1;
  27 int advice_add_embedded_repo = 1;
  28 int advice_ignored_hook = 1;
  29 int advice_waiting_for_editor = 1;
  30 int advice_graft_file_deprecated = 1;
  31 int advice_checkout_ambiguous_remote_branch_name = 1;
  32 int advice_nested_tag = 1;
  33 int advice_submodule_alternate_error_strategy_die = 1;
  34 int advice_add_nothing = 1;
  35
  36 static int advice_use_color = -1;
  37 static char advice_colors[][COLOR_MAXLEN] = {
  38         GIT_COLOR_RESET,
  39         GIT_COLOR_YELLOW,       /* HINT */
  40 };
  41
  42 enum color_advice {
  43         ADVICE_COLOR_RESET = 0,
  44         ADVICE_COLOR_HINT = 1,
  45 };
  46
  47 static int parse_advise_color_slot(const char *slot)
  48 {
  49         if (!strcasecmp(slot, "reset"))
  50                 return ADVICE_COLOR_RESET;
  51         if (!strcasecmp(slot, "hint"))
  52                 return ADVICE_COLOR_HINT;
  53         return -1;
  54 }
  55
  56 static const char *advise_get_color(enum color_advice ix)
  57 {
  58         if (want_color_stderr(advice_use_color))
  59                 return advice_colors[ix];
  60         return "";
  61 }
  62
  63 static struct {
  64         const char *name;
  65         int *preference;
  66 } advice_config[] = {
  67         { "fetchShowForcedUpdates", &advice_fetch_show_forced_updates },
  68         { "pushUpdateRejected", &advice_push_update_rejected },
  69         { "pushNonFFCurrent", &advice_push_non_ff_current },
  70         { "pushNonFFMatching", &advice_push_non_ff_matching },
  71         { "pushAlreadyExists", &advice_push_already_exists },
  72         { "pushFetchFirst", &advice_push_fetch_first },
  73         { "pushNeedsForce", &advice_push_needs_force },
  74         { "pushUnqualifiedRefName", &advice_push_unqualified_ref_name },
  75         { "statusHints", &advice_status_hints },
  76         { "statusUoption", &advice_status_u_option },
  77         { "statusAheadBehindWarning", &advice_status_ahead_behind_warning },
  78         { "commitBeforeMerge", &advice_commit_before_merge },
  79         { "resetQuiet", &advice_reset_quiet_warning },
  80         { "resolveConflict", &advice_resolve_conflict },
  81         { "sequencerInUse", &advice_sequencer_in_use },
  82         { "implicitIdentity", &advice_implicit_identity },
  83         { "detachedHead", &advice_detached_head },
  84         { "setupStreamFailure", &advice_set_upstream_failure },
  85         { "objectNameWarning", &advice_object_name_warning },
  86         { "amWorkDir", &advice_amworkdir },
  87         { "rmHints", &advice_rm_hints },
  88         { "addEmbeddedRepo", &advice_add_embedded_repo },
  89         { "ignoredHook", &advice_ignored_hook },
  90         { "waitingForEditor", &advice_waiting_for_editor },
  91         { "graftFileDeprecated", &advice_graft_file_deprecated },
  92         { "checkoutAmbiguousRemoteBranchName", &advice_checkout_ambiguous_remote_branch_name },
  93         { "nestedTag", &advice_nested_tag },
  94         { "submoduleAlternateErrorStrategyDie", &advice_submodule_alternate_error_strategy_die },
  95         { "addNothing", &advice_add_nothing },
  96
  97         /* make this an alias for backward compatibility */
  98         { "pushNonFastForward", &advice_push_update_rejected }
  99 };
 100
 101 void advise(const char *advice, ...)
 102 {
 103         struct strbuf buf = STRBUF_INIT;
 104         va_list params;
 105         const char *cp, *np;
 106
 107         va_start(params, advice);
 108         strbuf_vaddf(&buf, advice, params);
 109         va_end(params);
 110
 111         for (cp = buf.buf; *cp; cp = np) {
 112                 np = strchrnul(cp, '\n');
 113                 fprintf(stderr, _("%shint: %.*s%s\n"),
 114                         advise_get_color(ADVICE_COLOR_HINT),
 115                         (int)(np - cp), cp,
 116                         advise_get_color(ADVICE_COLOR_RESET));
 117                 if (*np)
 118                         np++;
 119         }
 120         strbuf_release(&buf);
 121 }
 122
 123 int git_default_advice_config(const char *var, const char *value)
 124 {
 125         const char *k, *slot_name;
 126         int i;
 127
 128         if (!strcmp(var, "color.advice")) {
 129                 advice_use_color = git_config_colorbool(var, value);
 130                 return 0;
 131         }
 132
 133         if (skip_prefix(var, "color.advice.", &slot_name)) {
 134                 int slot = parse_advise_color_slot(slot_name);
 135                 if (slot < 0)
 136                         return 0;
 137                 if (!value)
 138                         return config_error_nonbool(var);
 139                 return color_parse(value, advice_colors[slot]);
 140         }
 141
 142         if (!skip_prefix(var, "advice.", &k))
 143                 return 0;
 144
 145         for (i = 0; i < ARRAY_SIZE(advice_config); i++) {
 146                 if (strcasecmp(k, advice_config[i].name))
 147                         continue;
 148                 *advice_config[i].preference = git_config_bool(var, value);
 149                 return 0;
 150         }
 151
 152         return 0;
 153 }
 154
 155 void list_config_advices(struct string_list *list, const char *prefix)
 156 {
 157         int i;
 158
 159         for (i = 0; i < ARRAY_SIZE(advice_config); i++)
 160                 list_config_item(list, prefix, advice_config[i].name);
 161 }
 162
 163 int error_resolve_conflict(const char *me)
 164 {
 165         if (!strcmp(me, "cherry-pick"))
 166                 error(_("Cherry-picking is not possible because you have unmerged files."));
 167         else if (!strcmp(me, "commit"))
 168                 error(_("Committing is not possible because you have unmerged files."));
 169         else if (!strcmp(me, "merge"))
 170                 error(_("Merging is not possible because you have unmerged files."));
 171         else if (!strcmp(me, "pull"))
 172                 error(_("Pulling is not possible because you have unmerged files."));
 173         else if (!strcmp(me, "revert"))
 174                 error(_("Reverting is not possible because you have unmerged files."));
 175         else
 176                 error(_("It is not possible to %s because you have unmerged files."),
 177                         me);
 178
 179         if (advice_resolve_conflict)
 180                 /*
 181                  * Message used both when 'git commit' fails and when
 182                  * other commands doing a merge do.
 183                  */
 184                 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
 185                          "as appropriate to mark resolution and make a commit."));
 186         return -1;
 187 }
 188
 189 void NORETURN die_resolve_conflict(const char *me)
 190 {
 191         error_resolve_conflict(me);
 192         die(_("Exiting because of an unresolved conflict."));
 193 }
 194
 195 void NORETURN die_conclude_merge(void)
 196 {
 197         error(_("You have not concluded your merge (MERGE_HEAD exists)."));
 198         if (advice_resolve_conflict)
 199                 advise(_("Please, commit your changes before merging."));
 200         die(_("Exiting because of unfinished merge."));
 201 }
 202
 203 void detach_advice(const char *new_name)
 204 {
 205         const char *fmt =
 206         _("Note: switching to '%s'.\n"
 207         "\n"
 208         "You are in 'detached HEAD' state. You can look around, make experimental\n"
 209         "changes and commit them, and you can discard any commits you make in this\n"
 210         "state without impacting any branches by switching back to a branch.\n"
 211         "\n"
 212         "If you want to create a new branch to retain commits you create, you may\n"
 213         "do so (now or later) by using -c with the switch command. Example:\n"
 214         "\n"
 215         "  git switch -c <new-branch-name>\n"
 216         "\n"
 217         "Or undo this operation with:\n"
 218         "\n"
 219         "  git switch -\n"
 220         "\n"
 221         "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
 222
 223         fprintf(stderr, fmt, new_name);
 224 }