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