5 #include "string-list.h"
7 static int advice_use_color
= -1;
8 static char advice_colors
[][COLOR_MAXLEN
] = {
10 GIT_COLOR_YELLOW
, /* HINT */
14 ADVICE_COLOR_RESET
= 0,
15 ADVICE_COLOR_HINT
= 1,
18 static int parse_advise_color_slot(const char *slot
)
20 if (!strcasecmp(slot
, "reset"))
21 return ADVICE_COLOR_RESET
;
22 if (!strcasecmp(slot
, "hint"))
23 return ADVICE_COLOR_HINT
;
27 static const char *advise_get_color(enum color_advice ix
)
29 if (want_color_stderr(advice_use_color
))
30 return advice_colors
[ix
];
37 } advice_setting
[] = {
38 [ADVICE_ADD_EMBEDDED_REPO
] = { "addEmbeddedRepo", 1 },
39 [ADVICE_ADD_EMPTY_PATHSPEC
] = { "addEmptyPathspec", 1 },
40 [ADVICE_ADD_IGNORED_FILE
] = { "addIgnoredFile", 1 },
41 [ADVICE_AM_WORK_DIR
] = { "amWorkDir", 1 },
42 [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME
] = { "checkoutAmbiguousRemoteBranchName", 1 },
43 [ADVICE_COMMIT_BEFORE_MERGE
] = { "commitBeforeMerge", 1 },
44 [ADVICE_DETACHED_HEAD
] = { "detachedHead", 1 },
45 [ADVICE_FETCH_SHOW_FORCED_UPDATES
] = { "fetchShowForcedUpdates", 1 },
46 [ADVICE_GRAFT_FILE_DEPRECATED
] = { "graftFileDeprecated", 1 },
47 [ADVICE_IGNORED_HOOK
] = { "ignoredHook", 1 },
48 [ADVICE_IMPLICIT_IDENTITY
] = { "implicitIdentity", 1 },
49 [ADVICE_NESTED_TAG
] = { "nestedTag", 1 },
50 [ADVICE_OBJECT_NAME_WARNING
] = { "objectNameWarning", 1 },
51 [ADVICE_PUSH_ALREADY_EXISTS
] = { "pushAlreadyExists", 1 },
52 [ADVICE_PUSH_FETCH_FIRST
] = { "pushFetchFirst", 1 },
53 [ADVICE_PUSH_NEEDS_FORCE
] = { "pushNeedsForce", 1 },
54 [ADVICE_PUSH_REF_NEEDS_UPDATE
] = { "pushRefNeedsUpdate", 1 },
56 /* make this an alias for backward compatibility */
57 [ADVICE_PUSH_UPDATE_REJECTED_ALIAS
] = { "pushNonFastForward", 1 },
59 [ADVICE_PUSH_NON_FF_CURRENT
] = { "pushNonFFCurrent", 1 },
60 [ADVICE_PUSH_NON_FF_MATCHING
] = { "pushNonFFMatching", 1 },
61 [ADVICE_PUSH_UNQUALIFIED_REF_NAME
] = { "pushUnqualifiedRefName", 1 },
62 [ADVICE_PUSH_UPDATE_REJECTED
] = { "pushUpdateRejected", 1 },
63 [ADVICE_RESET_QUIET_WARNING
] = { "resetQuiet", 1 },
64 [ADVICE_RESOLVE_CONFLICT
] = { "resolveConflict", 1 },
65 [ADVICE_RM_HINTS
] = { "rmHints", 1 },
66 [ADVICE_SEQUENCER_IN_USE
] = { "sequencerInUse", 1 },
67 [ADVICE_SET_UPSTREAM_FAILURE
] = { "setUpstreamFailure", 1 },
68 [ADVICE_SKIPPED_CHERRY_PICKS
] = { "skippedCherryPicks", 1 },
69 [ADVICE_STATUS_AHEAD_BEHIND_WARNING
] = { "statusAheadBehindWarning", 1 },
70 [ADVICE_STATUS_HINTS
] = { "statusHints", 1 },
71 [ADVICE_STATUS_U_OPTION
] = { "statusUoption", 1 },
72 [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE
] = { "submoduleAlternateErrorStrategyDie", 1 },
73 [ADVICE_SUBMODULES_NOT_UPDATED
] = { "submodulesNotUpdated", 1 },
74 [ADVICE_UPDATE_SPARSE_PATH
] = { "updateSparsePath", 1 },
75 [ADVICE_WAITING_FOR_EDITOR
] = { "waitingForEditor", 1 },
78 static const char turn_off_instructions
[] =
80 "Disable this message with \"git config advice.%s false\"");
82 static void vadvise(const char *advice
, int display_instructions
,
83 const char *key
, va_list params
)
85 struct strbuf buf
= STRBUF_INIT
;
88 strbuf_vaddf(&buf
, advice
, params
);
90 if (display_instructions
)
91 strbuf_addf(&buf
, turn_off_instructions
, key
);
93 for (cp
= buf
.buf
; *cp
; cp
= np
) {
94 np
= strchrnul(cp
, '\n');
95 fprintf(stderr
, _("%shint: %.*s%s\n"),
96 advise_get_color(ADVICE_COLOR_HINT
),
98 advise_get_color(ADVICE_COLOR_RESET
));
102 strbuf_release(&buf
);
105 void advise(const char *advice
, ...)
108 va_start(params
, advice
);
109 vadvise(advice
, 0, "", params
);
113 int advice_enabled(enum advice_type type
)
116 case ADVICE_PUSH_UPDATE_REJECTED
:
117 return advice_setting
[ADVICE_PUSH_UPDATE_REJECTED
].enabled
&&
118 advice_setting
[ADVICE_PUSH_UPDATE_REJECTED_ALIAS
].enabled
;
120 return advice_setting
[type
].enabled
;
124 void advise_if_enabled(enum advice_type type
, const char *advice
, ...)
128 if (!advice_enabled(type
))
131 va_start(params
, advice
);
132 vadvise(advice
, 1, advice_setting
[type
].key
, params
);
136 int git_default_advice_config(const char *var
, const char *value
)
138 const char *k
, *slot_name
;
141 if (!strcmp(var
, "color.advice")) {
142 advice_use_color
= git_config_colorbool(var
, value
);
146 if (skip_prefix(var
, "color.advice.", &slot_name
)) {
147 int slot
= parse_advise_color_slot(slot_name
);
151 return config_error_nonbool(var
);
152 return color_parse(value
, advice_colors
[slot
]);
155 if (!skip_prefix(var
, "advice.", &k
))
158 for (i
= 0; i
< ARRAY_SIZE(advice_setting
); i
++) {
159 if (strcasecmp(k
, advice_setting
[i
].key
))
161 advice_setting
[i
].enabled
= git_config_bool(var
, value
);
168 void list_config_advices(struct string_list
*list
, const char *prefix
)
172 for (i
= 0; i
< ARRAY_SIZE(advice_setting
); i
++)
173 list_config_item(list
, prefix
, advice_setting
[i
].key
);
176 int error_resolve_conflict(const char *me
)
178 if (!strcmp(me
, "cherry-pick"))
179 error(_("Cherry-picking is not possible because you have unmerged files."));
180 else if (!strcmp(me
, "commit"))
181 error(_("Committing is not possible because you have unmerged files."));
182 else if (!strcmp(me
, "merge"))
183 error(_("Merging is not possible because you have unmerged files."));
184 else if (!strcmp(me
, "pull"))
185 error(_("Pulling is not possible because you have unmerged files."));
186 else if (!strcmp(me
, "revert"))
187 error(_("Reverting is not possible because you have unmerged files."));
189 error(_("It is not possible to %s because you have unmerged files."),
192 if (advice_enabled(ADVICE_RESOLVE_CONFLICT
))
194 * Message used both when 'git commit' fails and when
195 * other commands doing a merge do.
197 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
198 "as appropriate to mark resolution and make a commit."));
202 void NORETURN
die_resolve_conflict(const char *me
)
204 error_resolve_conflict(me
);
205 die(_("Exiting because of an unresolved conflict."));
208 void NORETURN
die_conclude_merge(void)
210 error(_("You have not concluded your merge (MERGE_HEAD exists)."));
211 if (advice_enabled(ADVICE_RESOLVE_CONFLICT
))
212 advise(_("Please, commit your changes before merging."));
213 die(_("Exiting because of unfinished merge."));
216 void NORETURN
die_ff_impossible(void)
218 die(_("Not possible to fast-forward, aborting."));
221 void advise_on_updating_sparse_paths(struct string_list
*pathspec_list
)
223 struct string_list_item
*item
;
225 if (!pathspec_list
->nr
)
228 fprintf(stderr
, _("The following paths and/or pathspecs matched paths that exist\n"
229 "outside of your sparse-checkout definition, so will not be\n"
230 "updated in the index:\n"));
231 for_each_string_list_item(item
, pathspec_list
)
232 fprintf(stderr
, "%s\n", item
->string
);
234 advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH
,
235 _("If you intend to update such entries, try one of the following:\n"
236 "* Use the --sparse option.\n"
237 "* Disable or modify the sparsity rules."));
240 void detach_advice(const char *new_name
)
243 _("Note: switching to '%s'.\n"
245 "You are in 'detached HEAD' state. You can look around, make experimental\n"
246 "changes and commit them, and you can discard any commits you make in this\n"
247 "state without impacting any branches by switching back to a branch.\n"
249 "If you want to create a new branch to retain commits you create, you may\n"
250 "do so (now or later) by using -c with the switch command. Example:\n"
252 " git switch -c <new-branch-name>\n"
254 "Or undo this operation with:\n"
258 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
260 fprintf(stderr
, fmt
, new_name
);