advice.c

   1 #include "cache.h"
   2 #include "config.h"
   3 #include "color.h"
   4 #include "help.h"
   5 #include "string-list.h"
   6
   7 static int advice_use_color = -1;
   8 static char advice_colors[][COLOR_MAXLEN] = {
   9         GIT_COLOR_RESET,
  10         GIT_COLOR_YELLOW,       /* HINT */
  11 };
  12
  13 enum color_advice {
  14         ADVICE_COLOR_RESET = 0,
  15         ADVICE_COLOR_HINT = 1,
  16 };
  17
  18 static int parse_advise_color_slot(const char *slot)
  19 {
  20         if (!strcasecmp(slot, "reset"))
  21                 return ADVICE_COLOR_RESET;
  22         if (!strcasecmp(slot, "hint"))
  23                 return ADVICE_COLOR_HINT;
  24         return -1;
  25 }
  26
  27 static const char *advise_get_color(enum color_advice ix)
  28 {
  29         if (want_color_stderr(advice_use_color))
  30                 return advice_colors[ix];
  31         return "";
  32 }
  33
  34 static struct {
  35         const char *key;
  36         int enabled;
  37 } advice_setting[] = {
  38         [ADVICE_ADD_EMBEDDED_REPO]                      = { "addEmbeddedRepo", 1 },
  39         [ADVICE_ADD_EMPTY_PATHSPEC]                     = { "addEmptyPathspec", 1 },
  40         [ADVICE_ADD_IGNORED_FILE]                       = { "addIgnoredFile", 1 },
  41         [ADVICE_AM_WORK_DIR]                            = { "amWorkDir", 1 },
  42         [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME]  = { "checkoutAmbiguousRemoteBranchName", 1 },
  43         [ADVICE_COMMIT_BEFORE_MERGE]                    = { "commitBeforeMerge", 1 },
  44         [ADVICE_DETACHED_HEAD]                          = { "detachedHead", 1 },
  45         [ADVICE_FETCH_SHOW_FORCED_UPDATES]              = { "fetchShowForcedUpdates", 1 },
  46         [ADVICE_GRAFT_FILE_DEPRECATED]                  = { "graftFileDeprecated", 1 },
  47         [ADVICE_IGNORED_HOOK]                           = { "ignoredHook", 1 },
  48         [ADVICE_IMPLICIT_IDENTITY]                      = { "implicitIdentity", 1 },
  49         [ADVICE_NESTED_TAG]                             = { "nestedTag", 1 },
  50         [ADVICE_OBJECT_NAME_WARNING]                    = { "objectNameWarning", 1 },
  51         [ADVICE_PUSH_ALREADY_EXISTS]                    = { "pushAlreadyExists", 1 },
  52         [ADVICE_PUSH_FETCH_FIRST]                       = { "pushFetchFirst", 1 },
  53         [ADVICE_PUSH_NEEDS_FORCE]                       = { "pushNeedsForce", 1 },
  54         [ADVICE_PUSH_REF_NEEDS_UPDATE]                  = { "pushRefNeedsUpdate", 1 },
  55
  56         /* make this an alias for backward compatibility */
  57         [ADVICE_PUSH_UPDATE_REJECTED_ALIAS]             = { "pushNonFastForward", 1 },
  58
  59         [ADVICE_PUSH_NON_FF_CURRENT]                    = { "pushNonFFCurrent", 1 },
  60         [ADVICE_PUSH_NON_FF_MATCHING]                   = { "pushNonFFMatching", 1 },
  61         [ADVICE_PUSH_UNQUALIFIED_REF_NAME]              = { "pushUnqualifiedRefName", 1 },
  62         [ADVICE_PUSH_UPDATE_REJECTED]                   = { "pushUpdateRejected", 1 },
  63         [ADVICE_RESET_QUIET_WARNING]                    = { "resetQuiet", 1 },
  64         [ADVICE_RESOLVE_CONFLICT]                       = { "resolveConflict", 1 },
  65         [ADVICE_RM_HINTS]                               = { "rmHints", 1 },
  66         [ADVICE_SEQUENCER_IN_USE]                       = { "sequencerInUse", 1 },
  67         [ADVICE_SET_UPSTREAM_FAILURE]                   = { "setUpstreamFailure", 1 },
  68         [ADVICE_SKIPPED_CHERRY_PICKS]                   = { "skippedCherryPicks", 1 },
  69         [ADVICE_STATUS_AHEAD_BEHIND_WARNING]            = { "statusAheadBehindWarning", 1 },
  70         [ADVICE_STATUS_HINTS]                           = { "statusHints", 1 },
  71         [ADVICE_STATUS_U_OPTION]                        = { "statusUoption", 1 },
  72         [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
  73         [ADVICE_UPDATE_SPARSE_PATH]                     = { "updateSparsePath", 1 },
  74         [ADVICE_WAITING_FOR_EDITOR]                     = { "waitingForEditor", 1 },
  75 };
  76
  77 static const char turn_off_instructions[] =
  78 N_("\n"
  79    "Disable this message with \"git config advice.%s false\"");
  80
  81 static void vadvise(const char *advice, int display_instructions,
  82                     const char *key, va_list params)
  83 {
  84         struct strbuf buf = STRBUF_INIT;
  85         const char *cp, *np;
  86
  87         strbuf_vaddf(&buf, advice, params);
  88
  89         if (display_instructions)
  90                 strbuf_addf(&buf, turn_off_instructions, key);
  91
  92         for (cp = buf.buf; *cp; cp = np) {
  93                 np = strchrnul(cp, '\n');
  94                 fprintf(stderr, _("%shint: %.*s%s\n"),
  95                         advise_get_color(ADVICE_COLOR_HINT),
  96                         (int)(np - cp), cp,
  97                         advise_get_color(ADVICE_COLOR_RESET));
  98                 if (*np)
  99                         np++;
 100         }
 101         strbuf_release(&buf);
 102 }
 103
 104 void advise(const char *advice, ...)
 105 {
 106         va_list params;
 107         va_start(params, advice);
 108         vadvise(advice, 0, "", params);
 109         va_end(params);
 110 }
 111
 112 int advice_enabled(enum advice_type type)
 113 {
 114         switch(type) {
 115         case ADVICE_PUSH_UPDATE_REJECTED:
 116                 return advice_setting[ADVICE_PUSH_UPDATE_REJECTED].enabled &&
 117                        advice_setting[ADVICE_PUSH_UPDATE_REJECTED_ALIAS].enabled;
 118         default:
 119                 return advice_setting[type].enabled;
 120         }
 121 }
 122
 123 void advise_if_enabled(enum advice_type type, const char *advice, ...)
 124 {
 125         va_list params;
 126
 127         if (!advice_enabled(type))
 128                 return;
 129
 130         va_start(params, advice);
 131         vadvise(advice, 1, advice_setting[type].key, params);
 132         va_end(params);
 133 }
 134
 135 int git_default_advice_config(const char *var, const char *value)
 136 {
 137         const char *k, *slot_name;
 138         int i;
 139
 140         if (!strcmp(var, "color.advice")) {
 141                 advice_use_color = git_config_colorbool(var, value);
 142                 return 0;
 143         }
 144
 145         if (skip_prefix(var, "color.advice.", &slot_name)) {
 146                 int slot = parse_advise_color_slot(slot_name);
 147                 if (slot < 0)
 148                         return 0;
 149                 if (!value)
 150                         return config_error_nonbool(var);
 151                 return color_parse(value, advice_colors[slot]);
 152         }
 153
 154         if (!skip_prefix(var, "advice.", &k))
 155                 return 0;
 156
 157         for (i = 0; i < ARRAY_SIZE(advice_setting); i++) {
 158                 if (strcasecmp(k, advice_setting[i].key))
 159                         continue;
 160                 advice_setting[i].enabled = git_config_bool(var, value);
 161                 return 0;
 162         }
 163
 164         return 0;
 165 }
 166
 167 void list_config_advices(struct string_list *list, const char *prefix)
 168 {
 169         int i;
 170
 171         for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
 172                 list_config_item(list, prefix, advice_setting[i].key);
 173 }
 174
 175 int error_resolve_conflict(const char *me)
 176 {
 177         if (!strcmp(me, "cherry-pick"))
 178                 error(_("Cherry-picking is not possible because you have unmerged files."));
 179         else if (!strcmp(me, "commit"))
 180                 error(_("Committing is not possible because you have unmerged files."));
 181         else if (!strcmp(me, "merge"))
 182                 error(_("Merging is not possible because you have unmerged files."));
 183         else if (!strcmp(me, "pull"))
 184                 error(_("Pulling is not possible because you have unmerged files."));
 185         else if (!strcmp(me, "revert"))
 186                 error(_("Reverting is not possible because you have unmerged files."));
 187         else
 188                 error(_("It is not possible to %s because you have unmerged files."),
 189                         me);
 190
 191         if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
 192                 /*
 193                  * Message used both when 'git commit' fails and when
 194                  * other commands doing a merge do.
 195                  */
 196                 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
 197                          "as appropriate to mark resolution and make a commit."));
 198         return -1;
 199 }
 200
 201 void NORETURN die_resolve_conflict(const char *me)
 202 {
 203         error_resolve_conflict(me);
 204         die(_("Exiting because of an unresolved conflict."));
 205 }
 206
 207 void NORETURN die_conclude_merge(void)
 208 {
 209         error(_("You have not concluded your merge (MERGE_HEAD exists)."));
 210         if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
 211                 advise(_("Please, commit your changes before merging."));
 212         die(_("Exiting because of unfinished merge."));
 213 }
 214
 215 void NORETURN die_ff_impossible(void)
 216 {
 217         die(_("Not possible to fast-forward, aborting."));
 218 }
 219
 220 void advise_on_updating_sparse_paths(struct string_list *pathspec_list)
 221 {
 222         struct string_list_item *item;
 223
 224         if (!pathspec_list->nr)
 225                 return;
 226
 227         fprintf(stderr, _("The following paths and/or pathspecs matched paths that exist\n"
 228                           "outside of your sparse-checkout definition, so will not be\n"
 229                           "updated in the index:\n"));
 230         for_each_string_list_item(item, pathspec_list)
 231                 fprintf(stderr, "%s\n", item->string);
 232
 233         advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH,
 234                           _("If you intend to update such entries, try one of the following:\n"
 235                             "* Use the --sparse option.\n"
 236                             "* Disable or modify the sparsity rules."));
 237 }
 238
 239 void detach_advice(const char *new_name)
 240 {
 241         const char *fmt =
 242         _("Note: switching to '%s'.\n"
 243         "\n"
 244         "You are in 'detached HEAD' state. You can look around, make experimental\n"
 245         "changes and commit them, and you can discard any commits you make in this\n"
 246         "state without impacting any branches by switching back to a branch.\n"
 247         "\n"
 248         "If you want to create a new branch to retain commits you create, you may\n"
 249         "do so (now or later) by using -c with the switch command. Example:\n"
 250         "\n"
 251         "  git switch -c <new-branch-name>\n"
 252         "\n"
 253         "Or undo this operation with:\n"
 254         "\n"
 255         "  git switch -\n"
 256         "\n"
 257         "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
 258
 259         fprintf(stderr, fmt, new_name);
 260 }