advice: revamp advise API
[git] / advice.h
1 #ifndef ADVICE_H
2 #define ADVICE_H
3
4 #include "git-compat-util.h"
5
6 extern int advice_fetch_show_forced_updates;
7 extern int advice_push_update_rejected;
8 extern int advice_push_non_ff_current;
9 extern int advice_push_non_ff_matching;
10 extern int advice_push_already_exists;
11 extern int advice_push_fetch_first;
12 extern int advice_push_needs_force;
13 extern int advice_push_unqualified_ref_name;
14 extern int advice_status_hints;
15 extern int advice_status_u_option;
16 extern int advice_status_ahead_behind_warning;
17 extern int advice_commit_before_merge;
18 extern int advice_reset_quiet_warning;
19 extern int advice_resolve_conflict;
20 extern int advice_sequencer_in_use;
21 extern int advice_implicit_identity;
22 extern int advice_detached_head;
23 extern int advice_set_upstream_failure;
24 extern int advice_object_name_warning;
25 extern int advice_amworkdir;
26 extern int advice_rm_hints;
27 extern int advice_add_embedded_repo;
28 extern int advice_ignored_hook;
29 extern int advice_waiting_for_editor;
30 extern int advice_graft_file_deprecated;
31 extern int advice_checkout_ambiguous_remote_branch_name;
32 extern int advice_nested_tag;
33 extern int advice_submodule_alternate_error_strategy_die;
34
35 /*
36  * To add a new advice, you need to:
37  * Define a new advice_type.
38  * Add a new entry to advice_setting array.
39  * Add the new config variable to Documentation/config/advice.txt.
40  * Call advise_if_enabled to print your advice.
41  */
42  enum advice_type {
43         ADVICE_ADD_EMBEDDED_REPO,
44         ADVICE_AM_WORK_DIR,
45         ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
46         ADVICE_COMMIT_BEFORE_MERGE,
47         ADVICE_DETACHED_HEAD,
48         ADVICE_FETCH_SHOW_FORCED_UPDATES,
49         ADVICE_GRAFT_FILE_DEPRECATED,
50         ADVICE_IGNORED_HOOK,
51         ADVICE_IMPLICIT_IDENTITY,
52         ADVICE_NESTED_TAG,
53         ADVICE_OBJECT_NAME_WARNING,
54         ADVICE_PUSH_ALREADY_EXISTS,
55         ADVICE_PUSH_FETCH_FIRST,
56         ADVICE_PUSH_NEEDS_FORCE,
57         ADVICE_PUSH_NON_FF_CURRENT,
58         ADVICE_PUSH_NON_FF_MATCHING,
59         ADVICE_PUSH_UNQUALIFIED_REF_NAME,
60         ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
61         ADVICE_PUSH_UPDATE_REJECTED,
62         ADVICE_RESET_QUIET_WARNING,
63         ADVICE_RESOLVE_CONFLICT,
64         ADVICE_RM_HINTS,
65         ADVICE_SEQUENCER_IN_USE,
66         ADVICE_SET_UPSTREAM_FAILURE,
67         ADVICE_STATUS_AHEAD_BEHIND_WARNING,
68         ADVICE_STATUS_HINTS,
69         ADVICE_STATUS_U_OPTION,
70         ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
71         ADVICE_WAITING_FOR_EDITOR,
72 };
73
74 int git_default_advice_config(const char *var, const char *value);
75 __attribute__((format (printf, 1, 2)))
76 void advise(const char *advice, ...);
77
78 /**
79  * Checks if advice type is enabled (can be printed to the user).
80  * Should be called before advise().
81  */
82 int advice_enabled(enum advice_type type);
83
84 /**
85  * Checks the visibility of the advice before printing.
86  */
87 void advise_if_enabled(enum advice_type type, const char *advice, ...);
88
89 int error_resolve_conflict(const char *me);
90 void NORETURN die_resolve_conflict(const char *me);
91 void NORETURN die_conclude_merge(void);
92 void detach_advice(const char *new_name);
93
94 #endif /* ADVICE_H */