]> git.ipfire.org Git - thirdparty/git.git/blame - advice.c
treewide: remove unnecessary includes of cache.h
[thirdparty/git.git] / advice.c
CommitLineData
fc7bd51b
EN
1#include "git-compat-util.h"
2#include "advice.h"
b2141fc1 3#include "config.h"
960786e7 4#include "color.h"
fc7bd51b 5#include "gettext.h"
3ac68a93 6#include "help.h"
a20f7047 7#include "string-list.h"
75194438 8
960786e7
RD
9static int advice_use_color = -1;
10static char advice_colors[][COLOR_MAXLEN] = {
11 GIT_COLOR_RESET,
12 GIT_COLOR_YELLOW, /* HINT */
13};
14
15enum color_advice {
16 ADVICE_COLOR_RESET = 0,
17 ADVICE_COLOR_HINT = 1,
18};
19
20static 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
29static 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
b3b18d16
HW
36static struct {
37 const char *key;
38 int enabled;
39} advice_setting[] = {
40 [ADVICE_ADD_EMBEDDED_REPO] = { "addEmbeddedRepo", 1 },
69290551
BB
41 [ADVICE_ADD_EMPTY_PATHSPEC] = { "addEmptyPathspec", 1 },
42 [ADVICE_ADD_IGNORED_FILE] = { "addIgnoredFile", 1 },
b3b18d16 43 [ADVICE_AM_WORK_DIR] = { "amWorkDir", 1 },
e4921d87 44 [ADVICE_AMBIGUOUS_FETCH_REFSPEC] = { "ambiguousFetchRefspec", 1 },
b3b18d16
HW
45 [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME] = { "checkoutAmbiguousRemoteBranchName", 1 },
46 [ADVICE_COMMIT_BEFORE_MERGE] = { "commitBeforeMerge", 1 },
47 [ADVICE_DETACHED_HEAD] = { "detachedHead", 1 },
808213ba 48 [ADVICE_SUGGEST_DETACHING_HEAD] = { "suggestDetachingHead", 1 },
765071a8 49 [ADVICE_DIVERGING] = { "diverging", 1 },
b3b18d16
HW
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 },
3b990aa6 59 [ADVICE_PUSH_REF_NEEDS_UPDATE] = { "pushRefNeedsUpdate", 1 },
b3b18d16
HW
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 },
9396251b 68 [ADVICE_RESET_NO_REFRESH_WARNING] = { "resetNoRefresh", 1 },
b3b18d16
HW
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 },
767a4ca6 73 [ADVICE_SKIPPED_CHERRY_PICKS] = { "skippedCherryPicks", 1 },
b3b18d16
HW
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 },
961b130d 78 [ADVICE_SUBMODULES_NOT_UPDATED] = { "submodulesNotUpdated", 1 },
a20f7047 79 [ADVICE_UPDATE_SPARSE_PATH] = { "updateSparsePath", 1 },
b3b18d16
HW
80 [ADVICE_WAITING_FOR_EDITOR] = { "waitingForEditor", 1 },
81};
82
83static const char turn_off_instructions[] =
84N_("\n"
85 "Disable this message with \"git config advice.%s false\"");
86
87static void vadvise(const char *advice, int display_instructions,
88 const char *key, va_list params)
38ef61cf 89{
23cb5bf3 90 struct strbuf buf = STRBUF_INIT;
23cb5bf3 91 const char *cp, *np;
38ef61cf 92
447b99c8 93 strbuf_vaddf(&buf, advice, params);
23cb5bf3 94
b3b18d16
HW
95 if (display_instructions)
96 strbuf_addf(&buf, turn_off_instructions, key);
23cb5bf3
JH
97
98 for (cp = buf.buf; *cp; cp = np) {
99 np = strchrnul(cp, '\n');
960786e7
RD
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));
23cb5bf3
JH
104 if (*np)
105 np++;
106 }
107 strbuf_release(&buf);
38ef61cf
RR
108}
109
06ac2b3b
HW
110void advise(const char *advice, ...)
111{
112 va_list params;
113 va_start(params, advice);
b3b18d16
HW
114 vadvise(advice, 0, "", params);
115 va_end(params);
116}
117
118int 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
129void 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);
06ac2b3b
HW
138 va_end(params);
139}
140
75194438
JK
141int git_default_advice_config(const char *var, const char *value)
142{
960786e7 143 const char *k, *slot_name;
75194438
JK
144 int i;
145
960786e7
RD
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
cf4fff57
JK
160 if (!skip_prefix(var, "advice.", &k))
161 return 0;
162
b3b18d16
HW
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);
75194438
JK
167 return 0;
168 }
169
170 return 0;
171}
d38a30df 172
3ac68a93
NTND
173void list_config_advices(struct string_list *list, const char *prefix)
174{
175 int i;
176
b3b18d16
HW
177 for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
178 list_config_item(list, prefix, advice_setting[i].key);
3ac68a93
NTND
179}
180
38ef61cf 181int error_resolve_conflict(const char *me)
d38a30df 182{
8785c425
VA
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
ed9bff08 197 if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
d38a30df
MM
198 /*
199 * Message used both when 'git commit' fails and when
200 * other commands doing a merge do.
201 */
c057b242 202 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
91e70e00 203 "as appropriate to mark resolution and make a commit."));
38ef61cf
RR
204 return -1;
205}
206
207void NORETURN die_resolve_conflict(const char *me)
208{
209 error_resolve_conflict(me);
8785c425 210 die(_("Exiting because of an unresolved conflict."));
d38a30df 211}
2857093b 212
4a4cf9e8
PT
213void NORETURN die_conclude_merge(void)
214{
215 error(_("You have not concluded your merge (MERGE_HEAD exists)."));
ed9bff08 216 if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
b7447679 217 advise(_("Please, commit your changes before merging."));
4a4cf9e8
PT
218 die(_("Exiting because of unfinished merge."));
219}
220
3d5fc24d
AH
221void NORETURN die_ff_impossible(void)
222{
765071a8
FC
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"));
3d5fc24d
AH
231 die(_("Not possible to fast-forward, aborting."));
232}
233
a20f7047
MT
234void 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
6579e788
DS
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"));
a20f7047
MT
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,
6579e788
DS
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."));
a20f7047
MT
251}
252
2857093b
NTND
253void detach_advice(const char *new_name)
254{
e9f3cec4 255 const char *fmt =
328c6cb8 256 _("Note: switching to '%s'.\n"
af9ded5b 257 "\n"
2857093b
NTND
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"
328c6cb8 260 "state without impacting any branches by switching back to a branch.\n"
af9ded5b 261 "\n"
2857093b 262 "If you want to create a new branch to retain commits you create, you may\n"
328c6cb8 263 "do so (now or later) by using -c with the switch command. Example:\n"
af9ded5b 264 "\n"
328c6cb8 265 " git switch -c <new-branch-name>\n"
af9ded5b 266 "\n"
328c6cb8 267 "Or undo this operation with:\n"
af9ded5b 268 "\n"
328c6cb8 269 " git switch -\n"
af9ded5b
NTND
270 "\n"
271 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
2857093b
NTND
272
273 fprintf(stderr, fmt, new_name);
274}
5efd533e
SY
275
276void 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}