]> git.ipfire.org Git - thirdparty/git.git/blame - advice.c
Git 2.42-rc0
[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 80 [ADVICE_WAITING_FOR_EDITOR] = { "waitingForEditor", 1 },
35f0383c 81 [ADVICE_WORKTREE_ADD_ORPHAN] = { "worktreeAddOrphan", 1 },
b3b18d16
HW
82};
83
84static const char turn_off_instructions[] =
85N_("\n"
86 "Disable this message with \"git config advice.%s false\"");
87
88static void vadvise(const char *advice, int display_instructions,
89 const char *key, va_list params)
38ef61cf 90{
23cb5bf3 91 struct strbuf buf = STRBUF_INIT;
23cb5bf3 92 const char *cp, *np;
38ef61cf 93
447b99c8 94 strbuf_vaddf(&buf, advice, params);
23cb5bf3 95
b3b18d16
HW
96 if (display_instructions)
97 strbuf_addf(&buf, turn_off_instructions, key);
23cb5bf3
JH
98
99 for (cp = buf.buf; *cp; cp = np) {
100 np = strchrnul(cp, '\n');
960786e7
RD
101 fprintf(stderr, _("%shint: %.*s%s\n"),
102 advise_get_color(ADVICE_COLOR_HINT),
103 (int)(np - cp), cp,
104 advise_get_color(ADVICE_COLOR_RESET));
23cb5bf3
JH
105 if (*np)
106 np++;
107 }
108 strbuf_release(&buf);
38ef61cf
RR
109}
110
06ac2b3b
HW
111void advise(const char *advice, ...)
112{
113 va_list params;
114 va_start(params, advice);
b3b18d16
HW
115 vadvise(advice, 0, "", params);
116 va_end(params);
117}
118
119int advice_enabled(enum advice_type type)
120{
121 switch(type) {
122 case ADVICE_PUSH_UPDATE_REJECTED:
123 return advice_setting[ADVICE_PUSH_UPDATE_REJECTED].enabled &&
124 advice_setting[ADVICE_PUSH_UPDATE_REJECTED_ALIAS].enabled;
125 default:
126 return advice_setting[type].enabled;
127 }
128}
129
130void advise_if_enabled(enum advice_type type, const char *advice, ...)
131{
132 va_list params;
133
134 if (!advice_enabled(type))
135 return;
136
137 va_start(params, advice);
138 vadvise(advice, 1, advice_setting[type].key, params);
06ac2b3b
HW
139 va_end(params);
140}
141
75194438
JK
142int git_default_advice_config(const char *var, const char *value)
143{
960786e7 144 const char *k, *slot_name;
75194438
JK
145 int i;
146
960786e7
RD
147 if (!strcmp(var, "color.advice")) {
148 advice_use_color = git_config_colorbool(var, value);
149 return 0;
150 }
151
152 if (skip_prefix(var, "color.advice.", &slot_name)) {
153 int slot = parse_advise_color_slot(slot_name);
154 if (slot < 0)
155 return 0;
156 if (!value)
157 return config_error_nonbool(var);
158 return color_parse(value, advice_colors[slot]);
159 }
160
cf4fff57
JK
161 if (!skip_prefix(var, "advice.", &k))
162 return 0;
163
b3b18d16
HW
164 for (i = 0; i < ARRAY_SIZE(advice_setting); i++) {
165 if (strcasecmp(k, advice_setting[i].key))
166 continue;
167 advice_setting[i].enabled = git_config_bool(var, value);
75194438
JK
168 return 0;
169 }
170
171 return 0;
172}
d38a30df 173
3ac68a93
NTND
174void list_config_advices(struct string_list *list, const char *prefix)
175{
176 int i;
177
b3b18d16
HW
178 for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
179 list_config_item(list, prefix, advice_setting[i].key);
3ac68a93
NTND
180}
181
38ef61cf 182int error_resolve_conflict(const char *me)
d38a30df 183{
8785c425
VA
184 if (!strcmp(me, "cherry-pick"))
185 error(_("Cherry-picking is not possible because you have unmerged files."));
186 else if (!strcmp(me, "commit"))
187 error(_("Committing is not possible because you have unmerged files."));
188 else if (!strcmp(me, "merge"))
189 error(_("Merging is not possible because you have unmerged files."));
190 else if (!strcmp(me, "pull"))
191 error(_("Pulling is not possible because you have unmerged files."));
192 else if (!strcmp(me, "revert"))
193 error(_("Reverting is not possible because you have unmerged files."));
194 else
195 error(_("It is not possible to %s because you have unmerged files."),
196 me);
197
ed9bff08 198 if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
d38a30df
MM
199 /*
200 * Message used both when 'git commit' fails and when
201 * other commands doing a merge do.
202 */
c057b242 203 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
91e70e00 204 "as appropriate to mark resolution and make a commit."));
38ef61cf
RR
205 return -1;
206}
207
208void NORETURN die_resolve_conflict(const char *me)
209{
210 error_resolve_conflict(me);
8785c425 211 die(_("Exiting because of an unresolved conflict."));
d38a30df 212}
2857093b 213
4a4cf9e8
PT
214void NORETURN die_conclude_merge(void)
215{
216 error(_("You have not concluded your merge (MERGE_HEAD exists)."));
ed9bff08 217 if (advice_enabled(ADVICE_RESOLVE_CONFLICT))
b7447679 218 advise(_("Please, commit your changes before merging."));
4a4cf9e8
PT
219 die(_("Exiting because of unfinished merge."));
220}
221
3d5fc24d
AH
222void NORETURN die_ff_impossible(void)
223{
765071a8
FC
224 advise_if_enabled(ADVICE_DIVERGING,
225 _("Diverging branches can't be fast-forwarded, you need to either:\n"
226 "\n"
227 "\tgit merge --no-ff\n"
228 "\n"
229 "or:\n"
230 "\n"
231 "\tgit rebase\n"));
3d5fc24d
AH
232 die(_("Not possible to fast-forward, aborting."));
233}
234
a20f7047
MT
235void advise_on_updating_sparse_paths(struct string_list *pathspec_list)
236{
237 struct string_list_item *item;
238
239 if (!pathspec_list->nr)
240 return;
241
6579e788
DS
242 fprintf(stderr, _("The following paths and/or pathspecs matched paths that exist\n"
243 "outside of your sparse-checkout definition, so will not be\n"
244 "updated in the index:\n"));
a20f7047
MT
245 for_each_string_list_item(item, pathspec_list)
246 fprintf(stderr, "%s\n", item->string);
247
248 advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH,
6579e788
DS
249 _("If you intend to update such entries, try one of the following:\n"
250 "* Use the --sparse option.\n"
251 "* Disable or modify the sparsity rules."));
a20f7047
MT
252}
253
2857093b
NTND
254void detach_advice(const char *new_name)
255{
e9f3cec4 256 const char *fmt =
328c6cb8 257 _("Note: switching to '%s'.\n"
af9ded5b 258 "\n"
2857093b
NTND
259 "You are in 'detached HEAD' state. You can look around, make experimental\n"
260 "changes and commit them, and you can discard any commits you make in this\n"
328c6cb8 261 "state without impacting any branches by switching back to a branch.\n"
af9ded5b 262 "\n"
2857093b 263 "If you want to create a new branch to retain commits you create, you may\n"
328c6cb8 264 "do so (now or later) by using -c with the switch command. Example:\n"
af9ded5b 265 "\n"
328c6cb8 266 " git switch -c <new-branch-name>\n"
af9ded5b 267 "\n"
328c6cb8 268 "Or undo this operation with:\n"
af9ded5b 269 "\n"
328c6cb8 270 " git switch -\n"
af9ded5b
NTND
271 "\n"
272 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
2857093b
NTND
273
274 fprintf(stderr, fmt, new_name);
275}
5efd533e
SY
276
277void advise_on_moving_dirty_path(struct string_list *pathspec_list)
278{
279 struct string_list_item *item;
280
281 if (!pathspec_list->nr)
282 return;
283
284 fprintf(stderr, _("The following paths have been moved outside the\n"
285 "sparse-checkout definition but are not sparse due to local\n"
286 "modifications.\n"));
287 for_each_string_list_item(item, pathspec_list)
288 fprintf(stderr, "%s\n", item->string);
289
290 advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH,
291 _("To correct the sparsity of these paths, do the following:\n"
292 "* Use \"git add --sparse <paths>\" to update the index\n"
293 "* Use \"git sparse-checkout reapply\" to apply the sparsity rules"));
294}