1 #include "git-compat-util.h"
7 #include "string-list.h"
9 static int advice_use_color
= -1;
10 static char advice_colors
[][COLOR_MAXLEN
] = {
12 GIT_COLOR_YELLOW
, /* HINT */
16 ADVICE_COLOR_RESET
= 0,
17 ADVICE_COLOR_HINT
= 1,
20 static int parse_advise_color_slot(const char *slot
)
22 if (!strcasecmp(slot
, "reset"))
23 return ADVICE_COLOR_RESET
;
24 if (!strcasecmp(slot
, "hint"))
25 return ADVICE_COLOR_HINT
;
29 static const char *advise_get_color(enum color_advice ix
)
31 if (want_color_stderr(advice_use_color
))
32 return advice_colors
[ix
];
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_AMBIGUOUS_FETCH_REFSPEC
] = { "ambiguousFetchRefspec", 1 },
44 [ADVICE_AM_WORK_DIR
] = { "amWorkDir", 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_DIVERGING
] = { "diverging", 1 },
49 [ADVICE_FETCH_SHOW_FORCED_UPDATES
] = { "fetchShowForcedUpdates", 1 },
50 [ADVICE_FORCE_DELETE_BRANCH
] = { "forceDeleteBranch", 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_NON_FF_CURRENT
] = { "pushNonFFCurrent", 1 },
60 [ADVICE_PUSH_NON_FF_MATCHING
] = { "pushNonFFMatching", 1 },
61 [ADVICE_PUSH_REF_NEEDS_UPDATE
] = { "pushRefNeedsUpdate", 1 },
62 [ADVICE_PUSH_UNQUALIFIED_REF_NAME
] = { "pushUnqualifiedRefName", 1 },
63 [ADVICE_PUSH_UPDATE_REJECTED
] = { "pushUpdateRejected", 1 },
64 [ADVICE_PUSH_UPDATE_REJECTED_ALIAS
] = { "pushNonFastForward", 1 }, /* backwards compatibility */
65 [ADVICE_RESET_NO_REFRESH_WARNING
] = { "resetNoRefresh", 1 },
66 [ADVICE_RESOLVE_CONFLICT
] = { "resolveConflict", 1 },
67 [ADVICE_RM_HINTS
] = { "rmHints", 1 },
68 [ADVICE_SEQUENCER_IN_USE
] = { "sequencerInUse", 1 },
69 [ADVICE_SET_UPSTREAM_FAILURE
] = { "setUpstreamFailure", 1 },
70 [ADVICE_SKIPPED_CHERRY_PICKS
] = { "skippedCherryPicks", 1 },
71 [ADVICE_STATUS_AHEAD_BEHIND_WARNING
] = { "statusAheadBehindWarning", 1 },
72 [ADVICE_STATUS_HINTS
] = { "statusHints", 1 },
73 [ADVICE_STATUS_U_OPTION
] = { "statusUoption", 1 },
74 [ADVICE_SUBMODULES_NOT_UPDATED
] = { "submodulesNotUpdated", 1 },
75 [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE
] = { "submoduleAlternateErrorStrategyDie", 1 },
76 [ADVICE_SUGGEST_DETACHING_HEAD
] = { "suggestDetachingHead", 1 },
77 [ADVICE_UPDATE_SPARSE_PATH
] = { "updateSparsePath", 1 },
78 [ADVICE_WAITING_FOR_EDITOR
] = { "waitingForEditor", 1 },
79 [ADVICE_WORKTREE_ADD_ORPHAN
] = { "worktreeAddOrphan", 1 },
82 static const char turn_off_instructions
[] =
84 "Disable this message with \"git config advice.%s false\"");
86 static void vadvise(const char *advice
, int display_instructions
,
87 const char *key
, va_list params
)
89 struct strbuf buf
= STRBUF_INIT
;
92 strbuf_vaddf(&buf
, advice
, params
);
94 if (display_instructions
)
95 strbuf_addf(&buf
, turn_off_instructions
, key
);
97 for (cp
= buf
.buf
; *cp
; cp
= np
) {
98 np
= strchrnul(cp
, '\n');
99 fprintf(stderr
, _("%shint: %.*s%s\n"),
100 advise_get_color(ADVICE_COLOR_HINT
),
102 advise_get_color(ADVICE_COLOR_RESET
));
106 strbuf_release(&buf
);
109 void advise(const char *advice
, ...)
112 va_start(params
, advice
);
113 vadvise(advice
, 0, "", params
);
117 int advice_enabled(enum advice_type type
)
120 case ADVICE_PUSH_UPDATE_REJECTED
:
121 return advice_setting
[ADVICE_PUSH_UPDATE_REJECTED
].enabled
&&
122 advice_setting
[ADVICE_PUSH_UPDATE_REJECTED_ALIAS
].enabled
;
124 return advice_setting
[type
].enabled
;
128 void advise_if_enabled(enum advice_type type
, const char *advice
, ...)
132 if (!advice_enabled(type
))
135 va_start(params
, advice
);
136 vadvise(advice
, 1, advice_setting
[type
].key
, params
);
140 int git_default_advice_config(const char *var
, const char *value
)
142 const char *k
, *slot_name
;
145 if (!strcmp(var
, "color.advice")) {
146 advice_use_color
= git_config_colorbool(var
, value
);
150 if (skip_prefix(var
, "color.advice.", &slot_name
)) {
151 int slot
= parse_advise_color_slot(slot_name
);
155 return config_error_nonbool(var
);
156 return color_parse(value
, advice_colors
[slot
]);
159 if (!skip_prefix(var
, "advice.", &k
))
162 for (i
= 0; i
< ARRAY_SIZE(advice_setting
); i
++) {
163 if (strcasecmp(k
, advice_setting
[i
].key
))
165 advice_setting
[i
].enabled
= git_config_bool(var
, value
);
172 void list_config_advices(struct string_list
*list
, const char *prefix
)
176 for (i
= 0; i
< ARRAY_SIZE(advice_setting
); i
++)
177 list_config_item(list
, prefix
, advice_setting
[i
].key
);
180 int error_resolve_conflict(const char *me
)
182 if (!strcmp(me
, "cherry-pick"))
183 error(_("Cherry-picking is not possible because you have unmerged files."));
184 else if (!strcmp(me
, "commit"))
185 error(_("Committing is not possible because you have unmerged files."));
186 else if (!strcmp(me
, "merge"))
187 error(_("Merging is not possible because you have unmerged files."));
188 else if (!strcmp(me
, "pull"))
189 error(_("Pulling is not possible because you have unmerged files."));
190 else if (!strcmp(me
, "revert"))
191 error(_("Reverting is not possible because you have unmerged files."));
192 else if (!strcmp(me
, "rebase"))
193 error(_("Rebasing is not possible because you have unmerged files."));
195 BUG("Unhandled conflict reason '%s'", me
);
197 if (advice_enabled(ADVICE_RESOLVE_CONFLICT
))
199 * Message used both when 'git commit' fails and when
200 * other commands doing a merge do.
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."));
207 void NORETURN
die_resolve_conflict(const char *me
)
209 error_resolve_conflict(me
);
210 die(_("Exiting because of an unresolved conflict."));
213 void NORETURN
die_conclude_merge(void)
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."));
221 void NORETURN
die_ff_impossible(void)
223 advise_if_enabled(ADVICE_DIVERGING
,
224 _("Diverging branches can't be fast-forwarded, you need to either:\n"
226 "\tgit merge --no-ff\n"
231 die(_("Not possible to fast-forward, aborting."));
234 void advise_on_updating_sparse_paths(struct string_list
*pathspec_list
)
236 struct string_list_item
*item
;
238 if (!pathspec_list
->nr
)
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
);
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."));
253 void detach_advice(const char *new_name
)
256 _("Note: switching to '%s'.\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"
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"
265 " git switch -c <new-branch-name>\n"
267 "Or undo this operation with:\n"
271 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
273 fprintf(stderr
, fmt
, new_name
);
276 void advise_on_moving_dirty_path(struct string_list
*pathspec_list
)
278 struct string_list_item
*item
;
280 if (!pathspec_list
->nr
)
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
);
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"));