gitcredentials(7): clarify quoting of helper examples
[git/raj.git] / advice.c
blob97f3f981b4b484a9edfed7cedadc3c01e51ff47e
1 #include "cache.h"
2 #include "config.h"
3 #include "color.h"
4 #include "help.h"
6 int advice_fetch_show_forced_updates = 1;
7 int advice_push_update_rejected = 1;
8 int advice_push_non_ff_current = 1;
9 int advice_push_non_ff_matching = 1;
10 int advice_push_already_exists = 1;
11 int advice_push_fetch_first = 1;
12 int advice_push_needs_force = 1;
13 int advice_push_unqualified_ref_name = 1;
14 int advice_status_hints = 1;
15 int advice_status_u_option = 1;
16 int advice_status_ahead_behind_warning = 1;
17 int advice_commit_before_merge = 1;
18 int advice_reset_quiet_warning = 1;
19 int advice_resolve_conflict = 1;
20 int advice_sequencer_in_use = 1;
21 int advice_implicit_identity = 1;
22 int advice_detached_head = 1;
23 int advice_set_upstream_failure = 1;
24 int advice_object_name_warning = 1;
25 int advice_amworkdir = 1;
26 int advice_rm_hints = 1;
27 int advice_add_embedded_repo = 1;
28 int advice_ignored_hook = 1;
29 int advice_waiting_for_editor = 1;
30 int advice_graft_file_deprecated = 1;
31 int advice_checkout_ambiguous_remote_branch_name = 1;
32 int advice_nested_tag = 1;
33 int advice_submodule_alternate_error_strategy_die = 1;
34 int advice_add_ignored_file = 1;
35 int advice_add_empty_pathspec = 1;
37 static int advice_use_color = -1;
38 static char advice_colors[][COLOR_MAXLEN] = {
39 GIT_COLOR_RESET,
40 GIT_COLOR_YELLOW, /* HINT */
43 enum color_advice {
44 ADVICE_COLOR_RESET = 0,
45 ADVICE_COLOR_HINT = 1,
48 static int parse_advise_color_slot(const char *slot)
50 if (!strcasecmp(slot, "reset"))
51 return ADVICE_COLOR_RESET;
52 if (!strcasecmp(slot, "hint"))
53 return ADVICE_COLOR_HINT;
54 return -1;
57 static const char *advise_get_color(enum color_advice ix)
59 if (want_color_stderr(advice_use_color))
60 return advice_colors[ix];
61 return "";
64 static struct {
65 const char *name;
66 int *preference;
67 } advice_config[] = {
68 { "fetchShowForcedUpdates", &advice_fetch_show_forced_updates },
69 { "pushUpdateRejected", &advice_push_update_rejected },
70 { "pushNonFFCurrent", &advice_push_non_ff_current },
71 { "pushNonFFMatching", &advice_push_non_ff_matching },
72 { "pushAlreadyExists", &advice_push_already_exists },
73 { "pushFetchFirst", &advice_push_fetch_first },
74 { "pushNeedsForce", &advice_push_needs_force },
75 { "pushUnqualifiedRefName", &advice_push_unqualified_ref_name },
76 { "statusHints", &advice_status_hints },
77 { "statusUoption", &advice_status_u_option },
78 { "statusAheadBehindWarning", &advice_status_ahead_behind_warning },
79 { "commitBeforeMerge", &advice_commit_before_merge },
80 { "resetQuiet", &advice_reset_quiet_warning },
81 { "resolveConflict", &advice_resolve_conflict },
82 { "sequencerInUse", &advice_sequencer_in_use },
83 { "implicitIdentity", &advice_implicit_identity },
84 { "detachedHead", &advice_detached_head },
85 { "setupStreamFailure", &advice_set_upstream_failure },
86 { "objectNameWarning", &advice_object_name_warning },
87 { "amWorkDir", &advice_amworkdir },
88 { "rmHints", &advice_rm_hints },
89 { "addEmbeddedRepo", &advice_add_embedded_repo },
90 { "ignoredHook", &advice_ignored_hook },
91 { "waitingForEditor", &advice_waiting_for_editor },
92 { "graftFileDeprecated", &advice_graft_file_deprecated },
93 { "checkoutAmbiguousRemoteBranchName", &advice_checkout_ambiguous_remote_branch_name },
94 { "nestedTag", &advice_nested_tag },
95 { "submoduleAlternateErrorStrategyDie", &advice_submodule_alternate_error_strategy_die },
96 { "addIgnoredFile", &advice_add_ignored_file },
97 { "addEmptyPathspec", &advice_add_empty_pathspec },
99 /* make this an alias for backward compatibility */
100 { "pushNonFastForward", &advice_push_update_rejected }
103 void advise(const char *advice, ...)
105 struct strbuf buf = STRBUF_INIT;
106 va_list params;
107 const char *cp, *np;
109 va_start(params, advice);
110 strbuf_vaddf(&buf, advice, params);
111 va_end(params);
113 for (cp = buf.buf; *cp; cp = np) {
114 np = strchrnul(cp, '\n');
115 fprintf(stderr, _("%shint: %.*s%s\n"),
116 advise_get_color(ADVICE_COLOR_HINT),
117 (int)(np - cp), cp,
118 advise_get_color(ADVICE_COLOR_RESET));
119 if (*np)
120 np++;
122 strbuf_release(&buf);
125 int git_default_advice_config(const char *var, const char *value)
127 const char *k, *slot_name;
128 int i;
130 if (!strcmp(var, "color.advice")) {
131 advice_use_color = git_config_colorbool(var, value);
132 return 0;
135 if (skip_prefix(var, "color.advice.", &slot_name)) {
136 int slot = parse_advise_color_slot(slot_name);
137 if (slot < 0)
138 return 0;
139 if (!value)
140 return config_error_nonbool(var);
141 return color_parse(value, advice_colors[slot]);
144 if (!skip_prefix(var, "advice.", &k))
145 return 0;
147 for (i = 0; i < ARRAY_SIZE(advice_config); i++) {
148 if (strcasecmp(k, advice_config[i].name))
149 continue;
150 *advice_config[i].preference = git_config_bool(var, value);
151 return 0;
154 return 0;
157 void list_config_advices(struct string_list *list, const char *prefix)
159 int i;
161 for (i = 0; i < ARRAY_SIZE(advice_config); i++)
162 list_config_item(list, prefix, advice_config[i].name);
165 int error_resolve_conflict(const char *me)
167 if (!strcmp(me, "cherry-pick"))
168 error(_("Cherry-picking is not possible because you have unmerged files."));
169 else if (!strcmp(me, "commit"))
170 error(_("Committing is not possible because you have unmerged files."));
171 else if (!strcmp(me, "merge"))
172 error(_("Merging is not possible because you have unmerged files."));
173 else if (!strcmp(me, "pull"))
174 error(_("Pulling is not possible because you have unmerged files."));
175 else if (!strcmp(me, "revert"))
176 error(_("Reverting is not possible because you have unmerged files."));
177 else
178 error(_("It is not possible to %s because you have unmerged files."),
179 me);
181 if (advice_resolve_conflict)
183 * Message used both when 'git commit' fails and when
184 * other commands doing a merge do.
186 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
187 "as appropriate to mark resolution and make a commit."));
188 return -1;
191 void NORETURN die_resolve_conflict(const char *me)
193 error_resolve_conflict(me);
194 die(_("Exiting because of an unresolved conflict."));
197 void NORETURN die_conclude_merge(void)
199 error(_("You have not concluded your merge (MERGE_HEAD exists)."));
200 if (advice_resolve_conflict)
201 advise(_("Please, commit your changes before merging."));
202 die(_("Exiting because of unfinished merge."));
205 void detach_advice(const char *new_name)
207 const char *fmt =
208 _("Note: switching to '%s'.\n"
209 "\n"
210 "You are in 'detached HEAD' state. You can look around, make experimental\n"
211 "changes and commit them, and you can discard any commits you make in this\n"
212 "state without impacting any branches by switching back to a branch.\n"
213 "\n"
214 "If you want to create a new branch to retain commits you create, you may\n"
215 "do so (now or later) by using -c with the switch command. Example:\n"
216 "\n"
217 " git switch -c <new-branch-name>\n"
218 "\n"
219 "Or undo this operation with:\n"
220 "\n"
221 " git switch -\n"
222 "\n"
223 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
225 fprintf(stderr, fmt, new_name);