1 #include "git-compat-util.h"
7 #include "string-list.h"
9 static int advice_use_color
= -1;
10 static char advice_colors
[][COLOR_MAXLEN
] = {
12 GIT_COLOR_YELLOW
, /* HINT */
16 ADVICE_COLOR_RESET
= 0,
17 ADVICE_COLOR_HINT
= 1,
20 static int parse_advise_color_slot(const char *slot
)
22 if (!strcasecmp(slot
, "reset"))
23 return ADVICE_COLOR_RESET
;
24 if (!strcasecmp(slot
, "hint"))
25 return ADVICE_COLOR_HINT
;
29 static const char *advise_get_color(enum color_advice ix
)
31 if (want_color_stderr(advice_use_color
))
32 return advice_colors
[ix
];
37 ADVICE_LEVEL_NONE
= 0,
38 ADVICE_LEVEL_DISABLED
,
44 enum advice_level level
;
45 } advice_setting
[] = {
46 [ADVICE_ADD_EMBEDDED_REPO
] = { "addEmbeddedRepo" },
47 [ADVICE_ADD_EMPTY_PATHSPEC
] = { "addEmptyPathspec" },
48 [ADVICE_ADD_IGNORED_FILE
] = { "addIgnoredFile" },
49 [ADVICE_AMBIGUOUS_FETCH_REFSPEC
] = { "ambiguousFetchRefspec" },
50 [ADVICE_AM_WORK_DIR
] = { "amWorkDir" },
51 [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME
] = { "checkoutAmbiguousRemoteBranchName" },
52 [ADVICE_COMMIT_BEFORE_MERGE
] = { "commitBeforeMerge" },
53 [ADVICE_DETACHED_HEAD
] = { "detachedHead" },
54 [ADVICE_DIVERGING
] = { "diverging" },
55 [ADVICE_FETCH_SHOW_FORCED_UPDATES
] = { "fetchShowForcedUpdates" },
56 [ADVICE_FORCE_DELETE_BRANCH
] = { "forceDeleteBranch" },
57 [ADVICE_GRAFT_FILE_DEPRECATED
] = { "graftFileDeprecated" },
58 [ADVICE_IGNORED_HOOK
] = { "ignoredHook" },
59 [ADVICE_IMPLICIT_IDENTITY
] = { "implicitIdentity" },
60 [ADVICE_NESTED_TAG
] = { "nestedTag" },
61 [ADVICE_OBJECT_NAME_WARNING
] = { "objectNameWarning" },
62 [ADVICE_PUSH_ALREADY_EXISTS
] = { "pushAlreadyExists" },
63 [ADVICE_PUSH_FETCH_FIRST
] = { "pushFetchFirst" },
64 [ADVICE_PUSH_NEEDS_FORCE
] = { "pushNeedsForce" },
65 [ADVICE_PUSH_NON_FF_CURRENT
] = { "pushNonFFCurrent" },
66 [ADVICE_PUSH_NON_FF_MATCHING
] = { "pushNonFFMatching" },
67 [ADVICE_PUSH_REF_NEEDS_UPDATE
] = { "pushRefNeedsUpdate" },
68 [ADVICE_PUSH_UNQUALIFIED_REF_NAME
] = { "pushUnqualifiedRefName" },
69 [ADVICE_PUSH_UPDATE_REJECTED
] = { "pushUpdateRejected" },
70 [ADVICE_PUSH_UPDATE_REJECTED_ALIAS
] = { "pushNonFastForward" }, /* backwards compatibility */
71 [ADVICE_REF_SYNTAX
] = { "refSyntax" },
72 [ADVICE_RESET_NO_REFRESH_WARNING
] = { "resetNoRefresh" },
73 [ADVICE_RESOLVE_CONFLICT
] = { "resolveConflict" },
74 [ADVICE_RM_HINTS
] = { "rmHints" },
75 [ADVICE_SEQUENCER_IN_USE
] = { "sequencerInUse" },
76 [ADVICE_SET_UPSTREAM_FAILURE
] = { "setUpstreamFailure" },
77 [ADVICE_SKIPPED_CHERRY_PICKS
] = { "skippedCherryPicks" },
78 [ADVICE_STATUS_AHEAD_BEHIND_WARNING
] = { "statusAheadBehindWarning" },
79 [ADVICE_STATUS_HINTS
] = { "statusHints" },
80 [ADVICE_STATUS_U_OPTION
] = { "statusUoption" },
81 [ADVICE_SUBMODULES_NOT_UPDATED
] = { "submodulesNotUpdated" },
82 [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE
] = { "submoduleAlternateErrorStrategyDie" },
83 [ADVICE_SUBMODULE_MERGE_CONFLICT
] = { "submoduleMergeConflict" },
84 [ADVICE_SUGGEST_DETACHING_HEAD
] = { "suggestDetachingHead" },
85 [ADVICE_UPDATE_SPARSE_PATH
] = { "updateSparsePath" },
86 [ADVICE_WAITING_FOR_EDITOR
] = { "waitingForEditor" },
87 [ADVICE_WORKTREE_ADD_ORPHAN
] = { "worktreeAddOrphan" },
90 static const char turn_off_instructions
[] =
92 "Disable this message with \"git config advice.%s false\"");
94 static void vadvise(const char *advice
, int display_instructions
,
95 const char *key
, va_list params
)
97 struct strbuf buf
= STRBUF_INIT
;
100 strbuf_vaddf(&buf
, advice
, params
);
102 if (display_instructions
)
103 strbuf_addf(&buf
, turn_off_instructions
, key
);
105 for (cp
= buf
.buf
; *cp
; cp
= np
) {
106 np
= strchrnul(cp
, '\n');
107 fprintf(stderr
, _("%shint: %.*s%s\n"),
108 advise_get_color(ADVICE_COLOR_HINT
),
110 advise_get_color(ADVICE_COLOR_RESET
));
114 strbuf_release(&buf
);
117 void advise(const char *advice
, ...)
120 va_start(params
, advice
);
121 vadvise(advice
, 0, "", params
);
125 int advice_enabled(enum advice_type type
)
127 int enabled
= advice_setting
[type
].level
!= ADVICE_LEVEL_DISABLED
;
129 if (type
== ADVICE_PUSH_UPDATE_REJECTED
)
131 advice_enabled(ADVICE_PUSH_UPDATE_REJECTED_ALIAS
);
136 void advise_if_enabled(enum advice_type type
, const char *advice
, ...)
140 if (!advice_enabled(type
))
143 va_start(params
, advice
);
144 vadvise(advice
, !advice_setting
[type
].level
, advice_setting
[type
].key
,
149 int git_default_advice_config(const char *var
, const char *value
)
151 const char *k
, *slot_name
;
154 if (!strcmp(var
, "color.advice")) {
155 advice_use_color
= git_config_colorbool(var
, value
);
159 if (skip_prefix(var
, "color.advice.", &slot_name
)) {
160 int slot
= parse_advise_color_slot(slot_name
);
164 return config_error_nonbool(var
);
165 return color_parse(value
, advice_colors
[slot
]);
168 if (!skip_prefix(var
, "advice.", &k
))
171 for (i
= 0; i
< ARRAY_SIZE(advice_setting
); i
++) {
172 if (strcasecmp(k
, advice_setting
[i
].key
))
174 advice_setting
[i
].level
= git_config_bool(var
, value
)
175 ? ADVICE_LEVEL_ENABLED
176 : ADVICE_LEVEL_DISABLED
;
183 void list_config_advices(struct string_list
*list
, const char *prefix
)
187 for (i
= 0; i
< ARRAY_SIZE(advice_setting
); i
++)
188 list_config_item(list
, prefix
, advice_setting
[i
].key
);
191 int error_resolve_conflict(const char *me
)
193 if (!strcmp(me
, "cherry-pick"))
194 error(_("Cherry-picking is not possible because you have unmerged files."));
195 else if (!strcmp(me
, "commit"))
196 error(_("Committing is not possible because you have unmerged files."));
197 else if (!strcmp(me
, "merge"))
198 error(_("Merging is not possible because you have unmerged files."));
199 else if (!strcmp(me
, "pull"))
200 error(_("Pulling is not possible because you have unmerged files."));
201 else if (!strcmp(me
, "revert"))
202 error(_("Reverting is not possible because you have unmerged files."));
203 else if (!strcmp(me
, "rebase"))
204 error(_("Rebasing is not possible because you have unmerged files."));
206 BUG("Unhandled conflict reason '%s'", me
);
208 if (advice_enabled(ADVICE_RESOLVE_CONFLICT
))
210 * Message used both when 'git commit' fails and when
211 * other commands doing a merge do.
213 advise(_("Fix them up in the work tree, and then use 'git add/rm <file>'\n"
214 "as appropriate to mark resolution and make a commit."));
218 void NORETURN
die_resolve_conflict(const char *me
)
220 error_resolve_conflict(me
);
221 die(_("Exiting because of an unresolved conflict."));
224 void NORETURN
die_conclude_merge(void)
226 error(_("You have not concluded your merge (MERGE_HEAD exists)."));
227 if (advice_enabled(ADVICE_RESOLVE_CONFLICT
))
228 advise(_("Please, commit your changes before merging."));
229 die(_("Exiting because of unfinished merge."));
232 void NORETURN
die_ff_impossible(void)
234 advise_if_enabled(ADVICE_DIVERGING
,
235 _("Diverging branches can't be fast-forwarded, you need to either:\n"
237 "\tgit merge --no-ff\n"
242 die(_("Not possible to fast-forward, aborting."));
245 void advise_on_updating_sparse_paths(struct string_list
*pathspec_list
)
247 struct string_list_item
*item
;
249 if (!pathspec_list
->nr
)
252 fprintf(stderr
, _("The following paths and/or pathspecs matched paths that exist\n"
253 "outside of your sparse-checkout definition, so will not be\n"
254 "updated in the index:\n"));
255 for_each_string_list_item(item
, pathspec_list
)
256 fprintf(stderr
, "%s\n", item
->string
);
258 advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH
,
259 _("If you intend to update such entries, try one of the following:\n"
260 "* Use the --sparse option.\n"
261 "* Disable or modify the sparsity rules."));
264 void detach_advice(const char *new_name
)
267 _("Note: switching to '%s'.\n"
269 "You are in 'detached HEAD' state. You can look around, make experimental\n"
270 "changes and commit them, and you can discard any commits you make in this\n"
271 "state without impacting any branches by switching back to a branch.\n"
273 "If you want to create a new branch to retain commits you create, you may\n"
274 "do so (now or later) by using -c with the switch command. Example:\n"
276 " git switch -c <new-branch-name>\n"
278 "Or undo this operation with:\n"
282 "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
284 fprintf(stderr
, fmt
, new_name
);
287 void advise_on_moving_dirty_path(struct string_list
*pathspec_list
)
289 struct string_list_item
*item
;
291 if (!pathspec_list
->nr
)
294 fprintf(stderr
, _("The following paths have been moved outside the\n"
295 "sparse-checkout definition but are not sparse due to local\n"
296 "modifications.\n"));
297 for_each_string_list_item(item
, pathspec_list
)
298 fprintf(stderr
, "%s\n", item
->string
);
300 advise_if_enabled(ADVICE_UPDATE_SPARSE_PATH
,
301 _("To correct the sparsity of these paths, do the following:\n"
302 "* Use \"git add --sparse <paths>\" to update the index\n"
303 "* Use \"git sparse-checkout reapply\" to apply the sparsity rules"));