]>
Commit | Line | Data |
---|---|---|
75194438 JK |
1 | #ifndef ADVICE_H |
2 | #define ADVICE_H | |
3 | ||
d38a30df MM |
4 | #include "git-compat-util.h" |
5 | ||
a20f7047 MT |
6 | struct string_list; |
7 | ||
b3b18d16 HW |
8 | /* |
9 | * To add a new advice, you need to: | |
10 | * Define a new advice_type. | |
11 | * Add a new entry to advice_setting array. | |
12 | * Add the new config variable to Documentation/config/advice.txt. | |
13 | * Call advise_if_enabled to print your advice. | |
14 | */ | |
15 | enum advice_type { | |
16 | ADVICE_ADD_EMBEDDED_REPO, | |
69290551 BB |
17 | ADVICE_ADD_EMPTY_PATHSPEC, |
18 | ADVICE_ADD_IGNORED_FILE, | |
b3b18d16 | 19 | ADVICE_AM_WORK_DIR, |
e4921d87 | 20 | ADVICE_AMBIGUOUS_FETCH_REFSPEC, |
b3b18d16 HW |
21 | ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME, |
22 | ADVICE_COMMIT_BEFORE_MERGE, | |
23 | ADVICE_DETACHED_HEAD, | |
808213ba | 24 | ADVICE_SUGGEST_DETACHING_HEAD, |
b3b18d16 HW |
25 | ADVICE_FETCH_SHOW_FORCED_UPDATES, |
26 | ADVICE_GRAFT_FILE_DEPRECATED, | |
27 | ADVICE_IGNORED_HOOK, | |
28 | ADVICE_IMPLICIT_IDENTITY, | |
29 | ADVICE_NESTED_TAG, | |
30 | ADVICE_OBJECT_NAME_WARNING, | |
31 | ADVICE_PUSH_ALREADY_EXISTS, | |
32 | ADVICE_PUSH_FETCH_FIRST, | |
33 | ADVICE_PUSH_NEEDS_FORCE, | |
34 | ADVICE_PUSH_NON_FF_CURRENT, | |
35 | ADVICE_PUSH_NON_FF_MATCHING, | |
36 | ADVICE_PUSH_UNQUALIFIED_REF_NAME, | |
37 | ADVICE_PUSH_UPDATE_REJECTED_ALIAS, | |
38 | ADVICE_PUSH_UPDATE_REJECTED, | |
3b990aa6 | 39 | ADVICE_PUSH_REF_NEEDS_UPDATE, |
9396251b | 40 | ADVICE_RESET_NO_REFRESH_WARNING, |
b3b18d16 HW |
41 | ADVICE_RESOLVE_CONFLICT, |
42 | ADVICE_RM_HINTS, | |
43 | ADVICE_SEQUENCER_IN_USE, | |
44 | ADVICE_SET_UPSTREAM_FAILURE, | |
45 | ADVICE_STATUS_AHEAD_BEHIND_WARNING, | |
46 | ADVICE_STATUS_HINTS, | |
47 | ADVICE_STATUS_U_OPTION, | |
48 | ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE, | |
961b130d | 49 | ADVICE_SUBMODULES_NOT_UPDATED, |
a20f7047 | 50 | ADVICE_UPDATE_SPARSE_PATH, |
b3b18d16 | 51 | ADVICE_WAITING_FOR_EDITOR, |
767a4ca6 | 52 | ADVICE_SKIPPED_CHERRY_PICKS, |
b3b18d16 HW |
53 | }; |
54 | ||
75194438 | 55 | int git_default_advice_config(const char *var, const char *value); |
4621085b | 56 | __attribute__((format (printf, 1, 2))) |
38ef61cf | 57 | void advise(const char *advice, ...); |
b3b18d16 HW |
58 | |
59 | /** | |
60 | * Checks if advice type is enabled (can be printed to the user). | |
61 | * Should be called before advise(). | |
62 | */ | |
63 | int advice_enabled(enum advice_type type); | |
64 | ||
65 | /** | |
66 | * Checks the visibility of the advice before printing. | |
67 | */ | |
927dc330 | 68 | __attribute__((format (printf, 2, 3))) |
b3b18d16 HW |
69 | void advise_if_enabled(enum advice_type type, const char *advice, ...); |
70 | ||
38ef61cf | 71 | int error_resolve_conflict(const char *me); |
55454427 | 72 | void NORETURN die_resolve_conflict(const char *me); |
4a4cf9e8 | 73 | void NORETURN die_conclude_merge(void); |
3d5fc24d | 74 | void NORETURN die_ff_impossible(void); |
a20f7047 | 75 | void advise_on_updating_sparse_paths(struct string_list *pathspec_list); |
2857093b | 76 | void detach_advice(const char *new_name); |
d38a30df | 77 | |
75194438 | 78 | #endif /* ADVICE_H */ |