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