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         [ADVICE_WORKTREE_ADD_ORPHAN]                    = { "worktreeAddOrphan", 1 },
  82 };
  83
  84 static const char turn_off_instructions[] =
  85 N_("\n"
  86    "Disable this message with \"git config advice.%s false\"");
  87
  88 static void vadvise(const char *advice, int display_instructions,
  89                     const char *key, va_list params)
  90 {
  91         struct strbuf buf = STRBUF_INIT;
  92         const char *cp, *np;
  93
  94         strbuf_vaddf(&buf, advice, params);
  95
  96         if (display_instructions)
  97                 strbuf_addf(&buf, turn_off_instructions, key);
  98
  99         for (cp = buf.buf; *cp; cp = np) {
 100                 np = strchrnul(cp, '\n');
 101                 fprintf(stderr, _("%shint: %.*s%s\n"),
 102                         advise_get_color(ADVICE_COLOR_HINT),
 103                         (int)(np - cp), cp,
 104                         advise_get_color(ADVICE_COLOR_RESET));
 105                 if (*np)
 106                         np++;
 107         }
 108         strbuf_release(&buf);
 109 }
 110
 111 void advise(const char *advice, ...)
 112 {
 113         va_list params;
 114         va_start(params, advice);
 115         vadvise(advice, 0, "", params);
 116         va_end(params);
 117 }
 118
 119 int advice_enabled(enum advice_type type)
 120 {
 121         switch(type) {
 122         case ADVICE_PUSH_UPDATE_REJECTED:
 123                 return advice_setting[ADVICE_PUSH_UPDATE_REJECTED].enabled &&
 124                        advice_setting[ADVICE_PUSH_UPDATE_REJECTED_ALIAS].enabled;
 125         default:
 126                 return advice_setting[type].enabled;
 127         }
 128 }
 129
 130 void advise_if_enabled(enum advice_type type, const char *advice, ...)
 131 {
 132         va_list params;
 133
 134         if (!advice_enabled(type))
 135                 return;
 136
 137         va_start(params, advice);
 138         vadvise(advice, 1, advice_setting[type].key, params);
 139         va_end(params);
 140 }
 141
 142 int git_default_advice_config(const char *var, const char *value)
 143 {
 144         const char *k, *slot_name;
 145         int i;
 146
 147         if (!strcmp(var, "color.advice")) {
 148                 advice_use_color = git_config_colorbool(var, value);
 149                 return 0;
 150         }
 151
 152         if (skip_prefix(var, "color.advice.", &slot_name)) {
 153                 int slot = parse_advise_color_slot(slot_name);
 154                 if (slot < 0)
 155                         return 0;
 156                 if (!value)
 157                         return config_error_nonbool(var);
 158                 return color_parse(value, advice_colors[slot]);
 159         }
 160
 161         if (!skip_prefix(var, "advice.", &k))
 162                 return 0;
 163
 164         for (i = 0; i < ARRAY_SIZE(advice_setting); i++) {
 165                 if (strcasecmp(k, advice_setting[i].key))
 166                         continue;
 167                 advice_setting[i].enabled = git_config_bool(var, value);
 168                 return 0;
 169         }
 170
 171         return 0;
 172 }
 173
 174 void list_config_advices(struct string_list *list, const char *prefix)
 175 {
 176         int i;
 177
 178         for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
 179                 list_config_item(list, prefix, advice_setting[i].key);
 180 }
 181
 182 int error_resolve_conflict(const char *me)
 183 {
 184         if (!strcmp(me, "cherry-pick"))
 185                 error(_("Cherry-picking is not possible because you have unmerged files."));
 186         else if (!strcmp(me, "commit"))
 187                 error(_("Committing is not possible because you have unmerged files."));
 188         else if (!strcmp(me, "merge"))
 189                 error(_("Merging is not possible because you have unmerged files."));
 190         else if (!strcmp(me, "pull"))
 191                 error(_("Pulling is not possible because you have unmerged files."));
 192         else if (!strcmp(me, "revert"))
 193                 error(_("Reverting is not possible because you have unmerged files."));
 194         else if (!strcmp(me, "rebase"))
 195                 error(_("Rebasing is not possible because you have unmerged files."));
 196         else
 197                 BUG("Unhandled conflict reason '%s'", me);
 198
 199         if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
 200                 /*
 201                  * Message used both when 'git commit' fails and when
 202                  * other commands doing a merge do.
 203                  */
 204                 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
 205                          "as appropriate to mark resolution and make a commit."));
 206         return -1;
 207 }
 208
 209 void NORETURN die_resolve_conflict(const char *me)
 210 {
 211         error_resolve_conflict(me);
 212         die(_("Exiting because of an unresolved conflict."));
 213 }
 214
 215 void NORETURN die_conclude_merge(void)
 216 {
 217         error(_("You have not concluded your merge (MERGE_HEAD exists)."));
 218         if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
 219                 advise(_("Please, commit your changes before merging."));
 220         die(_("Exiting because of unfinished merge."));
 221 }
 222
 223 void NORETURN die_ff_impossible(void)
 224 {
 225         advise_if_enabled(ADVICE_DIVERGING,
 226                 _("Diverging branches can't be fast-forwarded, you need to either:\n"
 227                 "\n"
 228                 "\tgit merge --no-ff\n"
 229                 "\n"
 230                 "or:\n"
 231                 "\n"
 232                 "\tgit rebase\n"));
 233         die(_("Not possible to fast-forward, aborting."));
 234 }
 235
 236 void advise_on_updating_sparse_paths(struct string_list *pathspec_list)
 237 {
 238         struct string_list_item *item;
 239
 240         if (!pathspec_list->nr)
 241                 return;
 242
 243         fprintf(stderr, _("The following paths and/or pathspecs matched paths that exist\n"
 244                           "outside of your sparse-checkout definition, so will not be\n"
 245                           "updated in the index:\n"));
 246         for_each_string_list_item(item, pathspec_list)
 247                 fprintf(stderr, "%s\n", item->string);
 248
 249         advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH,
 250                           _("If you intend to update such entries, try one of the following:\n"
 251                             "* Use the --sparse option.\n"
 252                             "* Disable or modify the sparsity rules."));
 253 }
 254
 255 void detach_advice(const char *new_name)
 256 {
 257         const char *fmt =
 258         _("Note: switching to '%s'.\n"
 259         "\n"
 260         "You are in 'detached HEAD' state. You can look around, make experimental\n"
 261         "changes and commit them, and you can discard any commits you make in this\n"
 262         "state without impacting any branches by switching back to a branch.\n"
 263         "\n"
 264         "If you want to create a new branch to retain commits you create, you may\n"
 265         "do so (now or later) by using -c with the switch command. Example:\n"
 266         "\n"
 267         "  git switch -c <new-branch-name>\n"
 268         "\n"
 269         "Or undo this operation with:\n"
 270         "\n"
 271         "  git switch -\n"
 272         "\n"
 273         "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
 274
 275         fprintf(stderr, fmt, new_name);
 276 }
 277
 278 void advise_on_moving_dirty_path(struct string_list *pathspec_list)
 279 {
 280         struct string_list_item *item;
 281
 282         if (!pathspec_list->nr)
 283                 return;
 284
 285         fprintf(stderr, _("The following paths have been moved outside the\n"
 286                           "sparse-checkout definition but are not sparse due to local\n"
 287                           "modifications.\n"));
 288         for_each_string_list_item(item, pathspec_list)
 289                 fprintf(stderr, "%s\n", item->string);
 290
 291         advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH,
 292                           _("To correct the sparsity of these paths, do the following:\n"
 293                             "* Use \"git add --sparse <paths>\" to update the index\n"
 294                             "* Use \"git sparse-checkout reapply\" to apply the sparsity rules"));
 295 }