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_push_ref_needs_update = 1;
  15 int advice_status_hints = 1;
  16 int advice_status_u_option = 1;
  17 int advice_status_ahead_behind_warning = 1;
  18 int advice_commit_before_merge = 1;
  19 int advice_reset_quiet_warning = 1;
  20 int advice_resolve_conflict = 1;
  21 int advice_sequencer_in_use = 1;
  22 int advice_implicit_identity = 1;
  23 int advice_detached_head = 1;
  24 int advice_set_upstream_failure = 1;
  25 int advice_object_name_warning = 1;
  26 int advice_amworkdir = 1;
  27 int advice_rm_hints = 1;
  28 int advice_add_embedded_repo = 1;
  29 int advice_ignored_hook = 1;
  30 int advice_waiting_for_editor = 1;
  31 int advice_graft_file_deprecated = 1;
  32 int advice_checkout_ambiguous_remote_branch_name = 1;
  33 int advice_submodule_alternate_error_strategy_die = 1;
  34 int advice_add_ignored_file = 1;
  35 int advice_add_empty_pathspec = 1;
  36
  37 static int advice_use_color = -1;
  38 static char advice_colors[][COLOR_MAXLEN] = {
  39         GIT_COLOR_RESET,
  40         GIT_COLOR_YELLOW,       /* HINT */
  41 };
  42
  43 enum color_advice {
  44         ADVICE_COLOR_RESET = 0,
  45         ADVICE_COLOR_HINT = 1,
  46 };
  47
  48 static int parse_advise_color_slot(const char *slot)
  49 {
  50         if (!strcasecmp(slot, "reset"))
  51                 return ADVICE_COLOR_RESET;
  52         if (!strcasecmp(slot, "hint"))
  53                 return ADVICE_COLOR_HINT;
  54         return -1;
  55 }
  56
  57 static const char *advise_get_color(enum color_advice ix)
  58 {
  59         if (want_color_stderr(advice_use_color))
  60                 return advice_colors[ix];
  61         return "";
  62 }
  63
  64 static struct {
  65         const char *name;
  66         int *preference;
  67 } advice_config[] = {
  68         { "fetchShowForcedUpdates", &advice_fetch_show_forced_updates },
  69         { "pushUpdateRejected", &advice_push_update_rejected },
  70         { "pushNonFFCurrent", &advice_push_non_ff_current },
  71         { "pushNonFFMatching", &advice_push_non_ff_matching },
  72         { "pushAlreadyExists", &advice_push_already_exists },
  73         { "pushFetchFirst", &advice_push_fetch_first },
  74         { "pushNeedsForce", &advice_push_needs_force },
  75         { "pushUnqualifiedRefName", &advice_push_unqualified_ref_name },
  76         { "pushRefNeedsUpdate", &advice_push_ref_needs_update },
  77         { "statusHints", &advice_status_hints },
  78         { "statusUoption", &advice_status_u_option },
  79         { "statusAheadBehindWarning", &advice_status_ahead_behind_warning },
  80         { "commitBeforeMerge", &advice_commit_before_merge },
  81         { "resetQuiet", &advice_reset_quiet_warning },
  82         { "resolveConflict", &advice_resolve_conflict },
  83         { "sequencerInUse", &advice_sequencer_in_use },
  84         { "implicitIdentity", &advice_implicit_identity },
  85         { "detachedHead", &advice_detached_head },
  86         { "setUpstreamFailure", &advice_set_upstream_failure },
  87         { "objectNameWarning", &advice_object_name_warning },
  88         { "amWorkDir", &advice_amworkdir },
  89         { "rmHints", &advice_rm_hints },
  90         { "addEmbeddedRepo", &advice_add_embedded_repo },
  91         { "ignoredHook", &advice_ignored_hook },
  92         { "waitingForEditor", &advice_waiting_for_editor },
  93         { "graftFileDeprecated", &advice_graft_file_deprecated },
  94         { "checkoutAmbiguousRemoteBranchName", &advice_checkout_ambiguous_remote_branch_name },
  95         { "submoduleAlternateErrorStrategyDie", &advice_submodule_alternate_error_strategy_die },
  96         { "addIgnoredFile", &advice_add_ignored_file },
  97         { "addEmptyPathspec", &advice_add_empty_pathspec },
  98
  99         /* make this an alias for backward compatibility */
 100         { "pushNonFastForward", &advice_push_update_rejected }
 101 };
 102
 103 static struct {
 104         const char *key;
 105         int enabled;
 106 } advice_setting[] = {
 107         [ADVICE_ADD_EMBEDDED_REPO]                      = { "addEmbeddedRepo", 1 },
 108         [ADVICE_AM_WORK_DIR]                            = { "amWorkDir", 1 },
 109         [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME]  = { "checkoutAmbiguousRemoteBranchName", 1 },
 110         [ADVICE_COMMIT_BEFORE_MERGE]                    = { "commitBeforeMerge", 1 },
 111         [ADVICE_DETACHED_HEAD]                          = { "detachedHead", 1 },
 112         [ADVICE_FETCH_SHOW_FORCED_UPDATES]              = { "fetchShowForcedUpdates", 1 },
 113         [ADVICE_GRAFT_FILE_DEPRECATED]                  = { "graftFileDeprecated", 1 },
 114         [ADVICE_IGNORED_HOOK]                           = { "ignoredHook", 1 },
 115         [ADVICE_IMPLICIT_IDENTITY]                      = { "implicitIdentity", 1 },
 116         [ADVICE_NESTED_TAG]                             = { "nestedTag", 1 },
 117         [ADVICE_OBJECT_NAME_WARNING]                    = { "objectNameWarning", 1 },
 118         [ADVICE_PUSH_ALREADY_EXISTS]                    = { "pushAlreadyExists", 1 },
 119         [ADVICE_PUSH_FETCH_FIRST]                       = { "pushFetchFirst", 1 },
 120         [ADVICE_PUSH_NEEDS_FORCE]                       = { "pushNeedsForce", 1 },
 121         [ADVICE_PUSH_REF_NEEDS_UPDATE]                  = { "pushRefNeedsUpdate", 1 },
 122
 123         /* make this an alias for backward compatibility */
 124         [ADVICE_PUSH_UPDATE_REJECTED_ALIAS]             = { "pushNonFastForward", 1 },
 125
 126         [ADVICE_PUSH_NON_FF_CURRENT]                    = { "pushNonFFCurrent", 1 },
 127         [ADVICE_PUSH_NON_FF_MATCHING]                   = { "pushNonFFMatching", 1 },
 128         [ADVICE_PUSH_UNQUALIFIED_REF_NAME]              = { "pushUnqualifiedRefName", 1 },
 129         [ADVICE_PUSH_UPDATE_REJECTED]                   = { "pushUpdateRejected", 1 },
 130         [ADVICE_RESET_QUIET_WARNING]                    = { "resetQuiet", 1 },
 131         [ADVICE_RESOLVE_CONFLICT]                       = { "resolveConflict", 1 },
 132         [ADVICE_RM_HINTS]                               = { "rmHints", 1 },
 133         [ADVICE_SEQUENCER_IN_USE]                       = { "sequencerInUse", 1 },
 134         [ADVICE_SET_UPSTREAM_FAILURE]                   = { "setUpstreamFailure", 1 },
 135         [ADVICE_STATUS_AHEAD_BEHIND_WARNING]            = { "statusAheadBehindWarning", 1 },
 136         [ADVICE_STATUS_HINTS]                           = { "statusHints", 1 },
 137         [ADVICE_STATUS_U_OPTION]                        = { "statusUoption", 1 },
 138         [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
 139         [ADVICE_WAITING_FOR_EDITOR]                     = { "waitingForEditor", 1 },
 140 };
 141
 142 static const char turn_off_instructions[] =
 143 N_("\n"
 144    "Disable this message with \"git config advice.%s false\"");
 145
 146 static void vadvise(const char *advice, int display_instructions,
 147                     const char *key, va_list params)
 148 {
 149         struct strbuf buf = STRBUF_INIT;
 150         const char *cp, *np;
 151
 152         strbuf_vaddf(&buf, advice, params);
 153
 154         if (display_instructions)
 155                 strbuf_addf(&buf, turn_off_instructions, key);
 156
 157         for (cp = buf.buf; *cp; cp = np) {
 158                 np = strchrnul(cp, '\n');
 159                 fprintf(stderr, _("%shint: %.*s%s\n"),
 160                         advise_get_color(ADVICE_COLOR_HINT),
 161                         (int)(np - cp), cp,
 162                         advise_get_color(ADVICE_COLOR_RESET));
 163                 if (*np)
 164                         np++;
 165         }
 166         strbuf_release(&buf);
 167 }
 168
 169 void advise(const char *advice, ...)
 170 {
 171         va_list params;
 172         va_start(params, advice);
 173         vadvise(advice, 0, "", params);
 174         va_end(params);
 175 }
 176
 177 int advice_enabled(enum advice_type type)
 178 {
 179         switch(type) {
 180         case ADVICE_PUSH_UPDATE_REJECTED:
 181                 return advice_setting[ADVICE_PUSH_UPDATE_REJECTED].enabled &&
 182                        advice_setting[ADVICE_PUSH_UPDATE_REJECTED_ALIAS].enabled;
 183         default:
 184                 return advice_setting[type].enabled;
 185         }
 186 }
 187
 188 void advise_if_enabled(enum advice_type type, const char *advice, ...)
 189 {
 190         va_list params;
 191
 192         if (!advice_enabled(type))
 193                 return;
 194
 195         va_start(params, advice);
 196         vadvise(advice, 1, advice_setting[type].key, params);
 197         va_end(params);
 198 }
 199
 200 int git_default_advice_config(const char *var, const char *value)
 201 {
 202         const char *k, *slot_name;
 203         int i;
 204
 205         if (!strcmp(var, "color.advice")) {
 206                 advice_use_color = git_config_colorbool(var, value);
 207                 return 0;
 208         }
 209
 210         if (skip_prefix(var, "color.advice.", &slot_name)) {
 211                 int slot = parse_advise_color_slot(slot_name);
 212                 if (slot < 0)
 213                         return 0;
 214                 if (!value)
 215                         return config_error_nonbool(var);
 216                 return color_parse(value, advice_colors[slot]);
 217         }
 218
 219         if (!skip_prefix(var, "advice.", &k))
 220                 return 0;
 221
 222         for (i = 0; i < ARRAY_SIZE(advice_config); i++) {
 223                 if (strcasecmp(k, advice_config[i].name))
 224                         continue;
 225                 *advice_config[i].preference = git_config_bool(var, value);
 226                 break;
 227         }
 228
 229         for (i = 0; i < ARRAY_SIZE(advice_setting); i++) {
 230                 if (strcasecmp(k, advice_setting[i].key))
 231                         continue;
 232                 advice_setting[i].enabled = git_config_bool(var, value);
 233                 return 0;
 234         }
 235
 236         return 0;
 237 }
 238
 239 void list_config_advices(struct string_list *list, const char *prefix)
 240 {
 241         int i;
 242
 243         for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
 244                 list_config_item(list, prefix, advice_setting[i].key);
 245 }
 246
 247 int error_resolve_conflict(const char *me)
 248 {
 249         if (!strcmp(me, "cherry-pick"))
 250                 error(_("Cherry-picking is not possible because you have unmerged files."));
 251         else if (!strcmp(me, "commit"))
 252                 error(_("Committing is not possible because you have unmerged files."));
 253         else if (!strcmp(me, "merge"))
 254                 error(_("Merging is not possible because you have unmerged files."));
 255         else if (!strcmp(me, "pull"))
 256                 error(_("Pulling is not possible because you have unmerged files."));
 257         else if (!strcmp(me, "revert"))
 258                 error(_("Reverting is not possible because you have unmerged files."));
 259         else
 260                 error(_("It is not possible to %s because you have unmerged files."),
 261                         me);
 262
 263         if (advice_resolve_conflict)
 264                 /*
 265                  * Message used both when 'git commit' fails and when
 266                  * other commands doing a merge do.
 267                  */
 268                 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
 269                          "as appropriate to mark resolution and make a commit."));
 270         return -1;
 271 }
 272
 273 void NORETURN die_resolve_conflict(const char *me)
 274 {
 275         error_resolve_conflict(me);
 276         die(_("Exiting because of an unresolved conflict."));
 277 }
 278
 279 void NORETURN die_conclude_merge(void)
 280 {
 281         error(_("You have not concluded your merge (MERGE_HEAD exists)."));
 282         if (advice_resolve_conflict)
 283                 advise(_("Please, commit your changes before merging."));
 284         die(_("Exiting because of unfinished merge."));
 285 }
 286
 287 void detach_advice(const char *new_name)
 288 {
 289         const char *fmt =
 290         _("Note: switching to '%s'.\n"
 291         "\n"
 292         "You are in 'detached HEAD' state. You can look around, make experimental\n"
 293         "changes and commit them, and you can discard any commits you make in this\n"
 294         "state without impacting any branches by switching back to a branch.\n"
 295         "\n"
 296         "If you want to create a new branch to retain commits you create, you may\n"
 297         "do so (now or later) by using -c with the switch command. Example:\n"
 298         "\n"
 299         "  git switch -c <new-branch-name>\n"
 300         "\n"
 301         "Or undo this operation with:\n"
 302         "\n"
 303         "  git switch -\n"
 304         "\n"
 305         "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
 306
 307         fprintf(stderr, fmt, new_name);
 308 }