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