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