advice.c

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