advice.c

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