]> git.ipfire.org Git - thirdparty/git.git/blame - advice.c
commit-graph: use free_commit_graph() instead of UNLEAK()
[thirdparty/git.git] / advice.c
CommitLineData
75194438 1#include "cache.h"
b2141fc1 2#include "config.h"
960786e7 3#include "color.h"
3ac68a93 4#include "help.h"
a20f7047 5#include "string-list.h"
75194438 6
960786e7
RD
7static int advice_use_color = -1;
8static char advice_colors[][COLOR_MAXLEN] = {
9 GIT_COLOR_RESET,
10 GIT_COLOR_YELLOW, /* HINT */
11};
12
13enum color_advice {
14 ADVICE_COLOR_RESET = 0,
15 ADVICE_COLOR_HINT = 1,
16};
17
18static 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
27static 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
b3b18d16
HW
34static struct {
35 const char *key;
36 int enabled;
37} advice_setting[] = {
38 [ADVICE_ADD_EMBEDDED_REPO] = { "addEmbeddedRepo", 1 },
69290551
BB
39 [ADVICE_ADD_EMPTY_PATHSPEC] = { "addEmptyPathspec", 1 },
40 [ADVICE_ADD_IGNORED_FILE] = { "addIgnoredFile", 1 },
b3b18d16 41 [ADVICE_AM_WORK_DIR] = { "amWorkDir", 1 },
e4921d87 42 [ADVICE_AMBIGUOUS_FETCH_REFSPEC] = { "ambiguousFetchRefspec", 1 },
b3b18d16
HW
43 [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME] = { "checkoutAmbiguousRemoteBranchName", 1 },
44 [ADVICE_COMMIT_BEFORE_MERGE] = { "commitBeforeMerge", 1 },
45 [ADVICE_DETACHED_HEAD] = { "detachedHead", 1 },
808213ba 46 [ADVICE_SUGGEST_DETACHING_HEAD] = { "suggestDetachingHead", 1 },
b3b18d16
HW
47 [ADVICE_FETCH_SHOW_FORCED_UPDATES] = { "fetchShowForcedUpdates", 1 },
48 [ADVICE_GRAFT_FILE_DEPRECATED] = { "graftFileDeprecated", 1 },
49 [ADVICE_IGNORED_HOOK] = { "ignoredHook", 1 },
50 [ADVICE_IMPLICIT_IDENTITY] = { "implicitIdentity", 1 },
51 [ADVICE_NESTED_TAG] = { "nestedTag", 1 },
52 [ADVICE_OBJECT_NAME_WARNING] = { "objectNameWarning", 1 },
53 [ADVICE_PUSH_ALREADY_EXISTS] = { "pushAlreadyExists", 1 },
54 [ADVICE_PUSH_FETCH_FIRST] = { "pushFetchFirst", 1 },
55 [ADVICE_PUSH_NEEDS_FORCE] = { "pushNeedsForce", 1 },
3b990aa6 56 [ADVICE_PUSH_REF_NEEDS_UPDATE] = { "pushRefNeedsUpdate", 1 },
b3b18d16
HW
57
58 /* make this an alias for backward compatibility */
59 [ADVICE_PUSH_UPDATE_REJECTED_ALIAS] = { "pushNonFastForward", 1 },
60
61 [ADVICE_PUSH_NON_FF_CURRENT] = { "pushNonFFCurrent", 1 },
62 [ADVICE_PUSH_NON_FF_MATCHING] = { "pushNonFFMatching", 1 },
63 [ADVICE_PUSH_UNQUALIFIED_REF_NAME] = { "pushUnqualifiedRefName", 1 },
64 [ADVICE_PUSH_UPDATE_REJECTED] = { "pushUpdateRejected", 1 },
9396251b 65 [ADVICE_RESET_NO_REFRESH_WARNING] = { "resetNoRefresh", 1 },
b3b18d16
HW
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 },
767a4ca6 70 [ADVICE_SKIPPED_CHERRY_PICKS] = { "skippedCherryPicks", 1 },
b3b18d16
HW
71 [ADVICE_STATUS_AHEAD_BEHIND_WARNING] = { "statusAheadBehindWarning", 1 },
72 [ADVICE_STATUS_HINTS] = { "statusHints", 1 },
73 [ADVICE_STATUS_U_OPTION] = { "statusUoption", 1 },
74 [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
961b130d 75 [ADVICE_SUBMODULES_NOT_UPDATED] = { "submodulesNotUpdated", 1 },
a20f7047 76 [ADVICE_UPDATE_SPARSE_PATH] = { "updateSparsePath", 1 },
b3b18d16
HW
77 [ADVICE_WAITING_FOR_EDITOR] = { "waitingForEditor", 1 },
78};
79
80static const char turn_off_instructions[] =
81N_("\n"
82 "Disable this message with \"git config advice.%s false\"");
83
84static void vadvise(const char *advice, int display_instructions,
85 const char *key, va_list params)
38ef61cf 86{
23cb5bf3 87 struct strbuf buf = STRBUF_INIT;
23cb5bf3 88 const char *cp, *np;
38ef61cf 89
447b99c8 90 strbuf_vaddf(&buf, advice, params);
23cb5bf3 91
b3b18d16
HW
92 if (display_instructions)
93 strbuf_addf(&buf, turn_off_instructions, key);
23cb5bf3
JH
94
95 for (cp = buf.buf; *cp; cp = np) {
96 np = strchrnul(cp, '\n');
960786e7
RD
97 fprintf(stderr, _("%shint: %.*s%s\n"),
98 advise_get_color(ADVICE_COLOR_HINT),
99 (int)(np - cp), cp,
100 advise_get_color(ADVICE_COLOR_RESET));
23cb5bf3
JH
101 if (*np)
102 np++;
103 }
104 strbuf_release(&buf);
38ef61cf
RR
105}
106
06ac2b3b
HW
107void advise(const char *advice, ...)
108{
109 va_list params;
110 va_start(params, advice);
b3b18d16
HW
111 vadvise(advice, 0, "", params);
112 va_end(params);
113}
114
115int advice_enabled(enum advice_type type)
116{
117 switch(type) {
118 case ADVICE_PUSH_UPDATE_REJECTED:
119 return advice_setting[ADVICE_PUSH_UPDATE_REJECTED].enabled &&
120 advice_setting[ADVICE_PUSH_UPDATE_REJECTED_ALIAS].enabled;
121 default:
122 return advice_setting[type].enabled;
123 }
124}
125
126void advise_if_enabled(enum advice_type type, const char *advice, ...)
127{
128 va_list params;
129
130 if (!advice_enabled(type))
131 return;
132
133 va_start(params, advice);
134 vadvise(advice, 1, advice_setting[type].key, params);
06ac2b3b
HW
135 va_end(params);
136}
137
75194438
JK
138int git_default_advice_config(const char *var, const char *value)
139{
960786e7 140 const char *k, *slot_name;
75194438
JK
141 int i;
142
960786e7
RD
143 if (!strcmp(var, "color.advice")) {
144 advice_use_color = git_config_colorbool(var, value);
145 return 0;
146 }
147
148 if (skip_prefix(var, "color.advice.", &slot_name)) {
149 int slot = parse_advise_color_slot(slot_name);
150 if (slot < 0)
151 return 0;
152 if (!value)
153 return config_error_nonbool(var);
154 return color_parse(value, advice_colors[slot]);
155 }
156
cf4fff57
JK
157 if (!skip_prefix(var, "advice.", &k))
158 return 0;
159
b3b18d16
HW
160 for (i = 0; i < ARRAY_SIZE(advice_setting); i++) {
161 if (strcasecmp(k, advice_setting[i].key))
162 continue;
163 advice_setting[i].enabled = git_config_bool(var, value);
75194438
JK
164 return 0;
165 }
166
167 return 0;
168}
d38a30df 169
3ac68a93
NTND
170void list_config_advices(struct string_list *list, const char *prefix)
171{
172 int i;
173
b3b18d16
HW
174 for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
175 list_config_item(list, prefix, advice_setting[i].key);
3ac68a93
NTND
176}
177
38ef61cf 178int error_resolve_conflict(const char *me)
d38a30df 179{
8785c425
VA
180 if (!strcmp(me, "cherry-pick"))
181 error(_("Cherry-picking is not possible because you have unmerged files."));
182 else if (!strcmp(me, "commit"))
183 error(_("Committing is not possible because you have unmerged files."));
184 else if (!strcmp(me, "merge"))
185 error(_("Merging is not possible because you have unmerged files."));
186 else if (!strcmp(me, "pull"))
187 error(_("Pulling is not possible because you have unmerged files."));
188 else if (!strcmp(me, "revert"))
189 error(_("Reverting is not possible because you have unmerged files."));
190 else
191 error(_("It is not possible to %s because you have unmerged files."),
192 me);
193
ed9bff08 194 if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
d38a30df
MM
195 /*
196 * Message used both when 'git commit' fails and when
197 * other commands doing a merge do.
198 */
c057b242 199 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
91e70e00 200 "as appropriate to mark resolution and make a commit."));
38ef61cf
RR
201 return -1;
202}
203
204void NORETURN die_resolve_conflict(const char *me)
205{
206 error_resolve_conflict(me);
8785c425 207 die(_("Exiting because of an unresolved conflict."));
d38a30df 208}
2857093b 209
4a4cf9e8
PT
210void NORETURN die_conclude_merge(void)
211{
212 error(_("You have not concluded your merge (MERGE_HEAD exists)."));
ed9bff08 213 if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
b7447679 214 advise(_("Please, commit your changes before merging."));
4a4cf9e8
PT
215 die(_("Exiting because of unfinished merge."));
216}
217
3d5fc24d
AH
218void NORETURN die_ff_impossible(void)
219{
220 die(_("Not possible to fast-forward, aborting."));
221}
222
a20f7047
MT
223void advise_on_updating_sparse_paths(struct string_list *pathspec_list)
224{
225 struct string_list_item *item;
226
227 if (!pathspec_list->nr)
228 return;
229
6579e788
DS
230 fprintf(stderr, _("The following paths and/or pathspecs matched paths that exist\n"
231 "outside of your sparse-checkout definition, so will not be\n"
232 "updated in the index:\n"));
a20f7047
MT
233 for_each_string_list_item(item, pathspec_list)
234 fprintf(stderr, "%s\n", item->string);
235
236 advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH,
6579e788
DS
237 _("If you intend to update such entries, try one of the following:\n"
238 "* Use the --sparse option.\n"
239 "* Disable or modify the sparsity rules."));
a20f7047
MT
240}
241
2857093b
NTND
242void detach_advice(const char *new_name)
243{
e9f3cec4 244 const char *fmt =
328c6cb8 245 _("Note: switching to '%s'.\n"
af9ded5b 246 "\n"
2857093b
NTND
247 "You are in 'detached HEAD' state. You can look around, make experimental\n"
248 "changes and commit them, and you can discard any commits you make in this\n"
328c6cb8 249 "state without impacting any branches by switching back to a branch.\n"
af9ded5b 250 "\n"
2857093b 251 "If you want to create a new branch to retain commits you create, you may\n"
328c6cb8 252 "do so (now or later) by using -c with the switch command. Example:\n"
af9ded5b 253 "\n"
328c6cb8 254 " git switch -c <new-branch-name>\n"
af9ded5b 255 "\n"
328c6cb8 256 "Or undo this operation with:\n"
af9ded5b 257 "\n"
328c6cb8 258 " git switch -\n"
af9ded5b
NTND
259 "\n"
260 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
2857093b
NTND
261
262 fprintf(stderr, fmt, new_name);
263}
5efd533e
SY
264
265void advise_on_moving_dirty_path(struct string_list *pathspec_list)
266{
267 struct string_list_item *item;
268
269 if (!pathspec_list->nr)
270 return;
271
272 fprintf(stderr, _("The following paths have been moved outside the\n"
273 "sparse-checkout definition but are not sparse due to local\n"
274 "modifications.\n"));
275 for_each_string_list_item(item, pathspec_list)
276 fprintf(stderr, "%s\n", item->string);
277
278 advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH,
279 _("To correct the sparsity of these paths, do the following:\n"
280 "* Use \"git add --sparse <paths>\" to update the index\n"
281 "* Use \"git sparse-checkout reapply\" to apply the sparsity rules"));
282}