]> git.ipfire.org Git - thirdparty/git.git/blame_incremental - advice.c
Merge branch 'bc/sha-256-part-2'
[thirdparty/git.git] / advice.c
... / ...
CommitLineData
1#include "cache.h"
2#include "config.h"
3#include "color.h"
4#include "help.h"
5
6int advice_fetch_show_forced_updates = 1;
7int advice_push_update_rejected = 1;
8int advice_push_non_ff_current = 1;
9int advice_push_non_ff_matching = 1;
10int advice_push_already_exists = 1;
11int advice_push_fetch_first = 1;
12int advice_push_needs_force = 1;
13int advice_push_unqualified_ref_name = 1;
14int advice_status_hints = 1;
15int advice_status_u_option = 1;
16int advice_status_ahead_behind_warning = 1;
17int advice_commit_before_merge = 1;
18int advice_reset_quiet_warning = 1;
19int advice_resolve_conflict = 1;
20int advice_sequencer_in_use = 1;
21int advice_implicit_identity = 1;
22int advice_detached_head = 1;
23int advice_set_upstream_failure = 1;
24int advice_object_name_warning = 1;
25int advice_amworkdir = 1;
26int advice_rm_hints = 1;
27int advice_add_embedded_repo = 1;
28int advice_ignored_hook = 1;
29int advice_waiting_for_editor = 1;
30int advice_graft_file_deprecated = 1;
31int advice_checkout_ambiguous_remote_branch_name = 1;
32int advice_submodule_alternate_error_strategy_die = 1;
33int advice_add_ignored_file = 1;
34int advice_add_empty_pathspec = 1;
35
36static int advice_use_color = -1;
37static char advice_colors[][COLOR_MAXLEN] = {
38 GIT_COLOR_RESET,
39 GIT_COLOR_YELLOW, /* HINT */
40};
41
42enum color_advice {
43 ADVICE_COLOR_RESET = 0,
44 ADVICE_COLOR_HINT = 1,
45};
46
47static int parse_advise_color_slot(const char *slot)
48{
49 if (!strcasecmp(slot, "reset"))
50 return ADVICE_COLOR_RESET;
51 if (!strcasecmp(slot, "hint"))
52 return ADVICE_COLOR_HINT;
53 return -1;
54}
55
56static const char *advise_get_color(enum color_advice ix)
57{
58 if (want_color_stderr(advice_use_color))
59 return advice_colors[ix];
60 return "";
61}
62
63static struct {
64 const char *name;
65 int *preference;
66} advice_config[] = {
67 { "fetchShowForcedUpdates", &advice_fetch_show_forced_updates },
68 { "pushUpdateRejected", &advice_push_update_rejected },
69 { "pushNonFFCurrent", &advice_push_non_ff_current },
70 { "pushNonFFMatching", &advice_push_non_ff_matching },
71 { "pushAlreadyExists", &advice_push_already_exists },
72 { "pushFetchFirst", &advice_push_fetch_first },
73 { "pushNeedsForce", &advice_push_needs_force },
74 { "pushUnqualifiedRefName", &advice_push_unqualified_ref_name },
75 { "statusHints", &advice_status_hints },
76 { "statusUoption", &advice_status_u_option },
77 { "statusAheadBehindWarning", &advice_status_ahead_behind_warning },
78 { "commitBeforeMerge", &advice_commit_before_merge },
79 { "resetQuiet", &advice_reset_quiet_warning },
80 { "resolveConflict", &advice_resolve_conflict },
81 { "sequencerInUse", &advice_sequencer_in_use },
82 { "implicitIdentity", &advice_implicit_identity },
83 { "detachedHead", &advice_detached_head },
84 { "setUpstreamFailure", &advice_set_upstream_failure },
85 { "objectNameWarning", &advice_object_name_warning },
86 { "amWorkDir", &advice_amworkdir },
87 { "rmHints", &advice_rm_hints },
88 { "addEmbeddedRepo", &advice_add_embedded_repo },
89 { "ignoredHook", &advice_ignored_hook },
90 { "waitingForEditor", &advice_waiting_for_editor },
91 { "graftFileDeprecated", &advice_graft_file_deprecated },
92 { "checkoutAmbiguousRemoteBranchName", &advice_checkout_ambiguous_remote_branch_name },
93 { "submoduleAlternateErrorStrategyDie", &advice_submodule_alternate_error_strategy_die },
94 { "addIgnoredFile", &advice_add_ignored_file },
95 { "addEmptyPathspec", &advice_add_empty_pathspec },
96
97 /* make this an alias for backward compatibility */
98 { "pushNonFastForward", &advice_push_update_rejected }
99};
100
101static struct {
102 const char *key;
103 int enabled;
104} advice_setting[] = {
105 [ADVICE_ADD_EMBEDDED_REPO] = { "addEmbeddedRepo", 1 },
106 [ADVICE_AM_WORK_DIR] = { "amWorkDir", 1 },
107 [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME] = { "checkoutAmbiguousRemoteBranchName", 1 },
108 [ADVICE_COMMIT_BEFORE_MERGE] = { "commitBeforeMerge", 1 },
109 [ADVICE_DETACHED_HEAD] = { "detachedHead", 1 },
110 [ADVICE_FETCH_SHOW_FORCED_UPDATES] = { "fetchShowForcedUpdates", 1 },
111 [ADVICE_GRAFT_FILE_DEPRECATED] = { "graftFileDeprecated", 1 },
112 [ADVICE_IGNORED_HOOK] = { "ignoredHook", 1 },
113 [ADVICE_IMPLICIT_IDENTITY] = { "implicitIdentity", 1 },
114 [ADVICE_NESTED_TAG] = { "nestedTag", 1 },
115 [ADVICE_OBJECT_NAME_WARNING] = { "objectNameWarning", 1 },
116 [ADVICE_PUSH_ALREADY_EXISTS] = { "pushAlreadyExists", 1 },
117 [ADVICE_PUSH_FETCH_FIRST] = { "pushFetchFirst", 1 },
118 [ADVICE_PUSH_NEEDS_FORCE] = { "pushNeedsForce", 1 },
119
120 /* make this an alias for backward compatibility */
121 [ADVICE_PUSH_UPDATE_REJECTED_ALIAS] = { "pushNonFastForward", 1 },
122
123 [ADVICE_PUSH_NON_FF_CURRENT] = { "pushNonFFCurrent", 1 },
124 [ADVICE_PUSH_NON_FF_MATCHING] = { "pushNonFFMatching", 1 },
125 [ADVICE_PUSH_UNQUALIFIED_REF_NAME] = { "pushUnqualifiedRefName", 1 },
126 [ADVICE_PUSH_UPDATE_REJECTED] = { "pushUpdateRejected", 1 },
127 [ADVICE_RESET_QUIET_WARNING] = { "resetQuiet", 1 },
128 [ADVICE_RESOLVE_CONFLICT] = { "resolveConflict", 1 },
129 [ADVICE_RM_HINTS] = { "rmHints", 1 },
130 [ADVICE_SEQUENCER_IN_USE] = { "sequencerInUse", 1 },
131 [ADVICE_SET_UPSTREAM_FAILURE] = { "setUpstreamFailure", 1 },
132 [ADVICE_STATUS_AHEAD_BEHIND_WARNING] = { "statusAheadBehindWarning", 1 },
133 [ADVICE_STATUS_HINTS] = { "statusHints", 1 },
134 [ADVICE_STATUS_U_OPTION] = { "statusUoption", 1 },
135 [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
136 [ADVICE_WAITING_FOR_EDITOR] = { "waitingForEditor", 1 },
137};
138
139static const char turn_off_instructions[] =
140N_("\n"
141 "Disable this message with \"git config advice.%s false\"");
142
143static void vadvise(const char *advice, int display_instructions,
144 const char *key, va_list params)
145{
146 struct strbuf buf = STRBUF_INIT;
147 const char *cp, *np;
148
149 strbuf_vaddf(&buf, advice, params);
150
151 if (display_instructions)
152 strbuf_addf(&buf, turn_off_instructions, key);
153
154 for (cp = buf.buf; *cp; cp = np) {
155 np = strchrnul(cp, '\n');
156 fprintf(stderr, _("%shint: %.*s%s\n"),
157 advise_get_color(ADVICE_COLOR_HINT),
158 (int)(np - cp), cp,
159 advise_get_color(ADVICE_COLOR_RESET));
160 if (*np)
161 np++;
162 }
163 strbuf_release(&buf);
164}
165
166void advise(const char *advice, ...)
167{
168 va_list params;
169 va_start(params, advice);
170 vadvise(advice, 0, "", params);
171 va_end(params);
172}
173
174int advice_enabled(enum advice_type type)
175{
176 switch(type) {
177 case ADVICE_PUSH_UPDATE_REJECTED:
178 return advice_setting[ADVICE_PUSH_UPDATE_REJECTED].enabled &&
179 advice_setting[ADVICE_PUSH_UPDATE_REJECTED_ALIAS].enabled;
180 default:
181 return advice_setting[type].enabled;
182 }
183}
184
185void advise_if_enabled(enum advice_type type, const char *advice, ...)
186{
187 va_list params;
188
189 if (!advice_enabled(type))
190 return;
191
192 va_start(params, advice);
193 vadvise(advice, 1, advice_setting[type].key, params);
194 va_end(params);
195}
196
197int git_default_advice_config(const char *var, const char *value)
198{
199 const char *k, *slot_name;
200 int i;
201
202 if (!strcmp(var, "color.advice")) {
203 advice_use_color = git_config_colorbool(var, value);
204 return 0;
205 }
206
207 if (skip_prefix(var, "color.advice.", &slot_name)) {
208 int slot = parse_advise_color_slot(slot_name);
209 if (slot < 0)
210 return 0;
211 if (!value)
212 return config_error_nonbool(var);
213 return color_parse(value, advice_colors[slot]);
214 }
215
216 if (!skip_prefix(var, "advice.", &k))
217 return 0;
218
219 for (i = 0; i < ARRAY_SIZE(advice_config); i++) {
220 if (strcasecmp(k, advice_config[i].name))
221 continue;
222 *advice_config[i].preference = git_config_bool(var, value);
223 break;
224 }
225
226 for (i = 0; i < ARRAY_SIZE(advice_setting); i++) {
227 if (strcasecmp(k, advice_setting[i].key))
228 continue;
229 advice_setting[i].enabled = git_config_bool(var, value);
230 return 0;
231 }
232
233 return 0;
234}
235
236void list_config_advices(struct string_list *list, const char *prefix)
237{
238 int i;
239
240 for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
241 list_config_item(list, prefix, advice_setting[i].key);
242}
243
244int error_resolve_conflict(const char *me)
245{
246 if (!strcmp(me, "cherry-pick"))
247 error(_("Cherry-picking is not possible because you have unmerged files."));
248 else if (!strcmp(me, "commit"))
249 error(_("Committing is not possible because you have unmerged files."));
250 else if (!strcmp(me, "merge"))
251 error(_("Merging is not possible because you have unmerged files."));
252 else if (!strcmp(me, "pull"))
253 error(_("Pulling is not possible because you have unmerged files."));
254 else if (!strcmp(me, "revert"))
255 error(_("Reverting is not possible because you have unmerged files."));
256 else
257 error(_("It is not possible to %s because you have unmerged files."),
258 me);
259
260 if (advice_resolve_conflict)
261 /*
262 * Message used both when 'git commit' fails and when
263 * other commands doing a merge do.
264 */
265 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
266 "as appropriate to mark resolution and make a commit."));
267 return -1;
268}
269
270void NORETURN die_resolve_conflict(const char *me)
271{
272 error_resolve_conflict(me);
273 die(_("Exiting because of an unresolved conflict."));
274}
275
276void NORETURN die_conclude_merge(void)
277{
278 error(_("You have not concluded your merge (MERGE_HEAD exists)."));
279 if (advice_resolve_conflict)
280 advise(_("Please, commit your changes before merging."));
281 die(_("Exiting because of unfinished merge."));
282}
283
284void detach_advice(const char *new_name)
285{
286 const char *fmt =
287 _("Note: switching to '%s'.\n"
288 "\n"
289 "You are in 'detached HEAD' state. You can look around, make experimental\n"
290 "changes and commit them, and you can discard any commits you make in this\n"
291 "state without impacting any branches by switching back to a branch.\n"
292 "\n"
293 "If you want to create a new branch to retain commits you create, you may\n"
294 "do so (now or later) by using -c with the switch command. Example:\n"
295 "\n"
296 " git switch -c <new-branch-name>\n"
297 "\n"
298 "Or undo this operation with:\n"
299 "\n"
300 " git switch -\n"
301 "\n"
302 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
303
304 fprintf(stderr, fmt, new_name);
305}