| 1 | #ifndef ADVICE_H |
| 2 | #define ADVICE_H |
| 3 | |
| 4 | struct string_list; |
| 5 | |
| 6 | /* |
| 7 | * To add a new advice, you need to: |
| 8 | * Define a new advice_type. |
| 9 | * Add a new entry to advice_setting array. |
| 10 | * Add the new config variable to Documentation/config/advice.adoc. |
| 11 | * Call advise_if_enabled to print your advice. |
| 12 | */ |
| 13 | enum advice_type { |
| 14 | ADVICE_ADD_EMBEDDED_REPO, |
| 15 | ADVICE_ADD_EMPTY_PATHSPEC, |
| 16 | ADVICE_ADD_IGNORED_FILE, |
| 17 | ADVICE_AMBIGUOUS_FETCH_REFSPEC, |
| 18 | ADVICE_AM_WORK_DIR, |
| 19 | ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME, |
| 20 | ADVICE_COMMIT_BEFORE_MERGE, |
| 21 | ADVICE_DEFAULT_BRANCH_NAME, /* To be retired sometime after Git 3.0 */ |
| 22 | ADVICE_DETACHED_HEAD, |
| 23 | ADVICE_DIVERGING, |
| 24 | ADVICE_FETCH_SET_HEAD_WARN, |
| 25 | ADVICE_FETCH_SHOW_FORCED_UPDATES, |
| 26 | ADVICE_FORCE_DELETE_BRANCH, |
| 27 | ADVICE_GRAFT_FILE_DEPRECATED, |
| 28 | ADVICE_HISTORY_UPDATE_REFS, |
| 29 | ADVICE_IGNORED_HOOK, |
| 30 | ADVICE_IMPLICIT_IDENTITY, |
| 31 | ADVICE_MERGE_CONFLICT, |
| 32 | ADVICE_NESTED_TAG, |
| 33 | ADVICE_OBJECT_NAME_WARNING, |
| 34 | ADVICE_PUSH_ALREADY_EXISTS, |
| 35 | ADVICE_PUSH_FETCH_FIRST, |
| 36 | ADVICE_PUSH_NEEDS_FORCE, |
| 37 | ADVICE_PUSH_NON_FF_CURRENT, |
| 38 | ADVICE_PUSH_NON_FF_MATCHING, |
| 39 | ADVICE_PUSH_REF_NEEDS_UPDATE, |
| 40 | ADVICE_PUSH_REPO_LOOKS_LIKE_REF, |
| 41 | ADVICE_PUSH_UNQUALIFIED_REF_NAME, |
| 42 | ADVICE_PUSH_UPDATE_REJECTED, |
| 43 | ADVICE_PUSH_UPDATE_REJECTED_ALIAS, |
| 44 | ADVICE_REBASE_TODO_ERROR, |
| 45 | ADVICE_REF_SYNTAX, |
| 46 | ADVICE_RESET_NO_REFRESH_WARNING, |
| 47 | ADVICE_RESOLVE_CONFLICT, |
| 48 | ADVICE_RM_HINTS, |
| 49 | ADVICE_SEQUENCER_IN_USE, |
| 50 | ADVICE_SET_UPSTREAM_FAILURE, |
| 51 | ADVICE_SKIPPED_CHERRY_PICKS, |
| 52 | ADVICE_SPARSE_INDEX_EXPANDED, |
| 53 | ADVICE_STATUS_AHEAD_BEHIND_WARNING, |
| 54 | ADVICE_STATUS_HINTS, |
| 55 | ADVICE_STATUS_U_OPTION, |
| 56 | ADVICE_SUBMODULES_NOT_UPDATED, |
| 57 | ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE, |
| 58 | ADVICE_SUBMODULE_MERGE_CONFLICT, |
| 59 | ADVICE_SUGGEST_DETACHING_HEAD, |
| 60 | ADVICE_UPDATE_SPARSE_PATH, |
| 61 | ADVICE_WAITING_FOR_EDITOR, |
| 62 | ADVICE_WORKTREE_ADD_ORPHAN, |
| 63 | }; |
| 64 | |
| 65 | int git_default_advice_config(const char *var, const char *value); |
| 66 | __attribute__((format (printf, 1, 2))) |
| 67 | void advise(const char *advice, ...); |
| 68 | |
| 69 | /** |
| 70 | * Checks if advice type is enabled (can be printed to the user). |
| 71 | * Should be called before advise(). |
| 72 | */ |
| 73 | int advice_enabled(enum advice_type type); |
| 74 | |
| 75 | /** |
| 76 | * Checks the visibility of the advice before printing. |
| 77 | */ |
| 78 | __attribute__((format (printf, 2, 3))) |
| 79 | void advise_if_enabled(enum advice_type type, const char *advice, ...); |
| 80 | |
| 81 | int error_resolve_conflict(const char *me); |
| 82 | void NORETURN die_resolve_conflict(const char *me); |
| 83 | void NORETURN die_conclude_merge(void); |
| 84 | void NORETURN die_ff_impossible(void); |
| 85 | void advise_on_updating_sparse_paths(struct string_list *pathspec_list); |
| 86 | void detach_advice(const char *new_name); |
| 87 | void advise_on_moving_dirty_path(struct string_list *pathspec_list); |
| 88 | |
| 89 | #endif /* ADVICE_H */ |