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