advice.c

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