pack-objects: fix --no-keep-true-parents
[git/debian.git] / advice.h
blob0f584163f5808ce536ff5d1a5294eed2437ba23b
1 #ifndef ADVICE_H
2 #define ADVICE_H
4 struct string_list;
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.txt.
11 * Call advise_if_enabled to print your advice.
13 enum advice_type {
14 ADVICE_ADD_EMBEDDED_REPO,
15 ADVICE_ADD_EMPTY_PATHSPEC,
16 ADVICE_ADD_IGNORED_FILE,
17 ADVICE_AM_WORK_DIR,
18 ADVICE_AMBIGUOUS_FETCH_REFSPEC,
19 ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
20 ADVICE_COMMIT_BEFORE_MERGE,
21 ADVICE_DETACHED_HEAD,
22 ADVICE_DIVERGING,
23 ADVICE_SUGGEST_DETACHING_HEAD,
24 ADVICE_FETCH_SHOW_FORCED_UPDATES,
25 ADVICE_GRAFT_FILE_DEPRECATED,
26 ADVICE_IGNORED_HOOK,
27 ADVICE_IMPLICIT_IDENTITY,
28 ADVICE_NESTED_TAG,
29 ADVICE_OBJECT_NAME_WARNING,
30 ADVICE_PUSH_ALREADY_EXISTS,
31 ADVICE_PUSH_FETCH_FIRST,
32 ADVICE_PUSH_NEEDS_FORCE,
33 ADVICE_PUSH_NON_FF_CURRENT,
34 ADVICE_PUSH_NON_FF_MATCHING,
35 ADVICE_PUSH_UNQUALIFIED_REF_NAME,
36 ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
37 ADVICE_PUSH_UPDATE_REJECTED,
38 ADVICE_PUSH_REF_NEEDS_UPDATE,
39 ADVICE_RESET_NO_REFRESH_WARNING,
40 ADVICE_RESOLVE_CONFLICT,
41 ADVICE_RM_HINTS,
42 ADVICE_SEQUENCER_IN_USE,
43 ADVICE_SET_UPSTREAM_FAILURE,
44 ADVICE_STATUS_AHEAD_BEHIND_WARNING,
45 ADVICE_STATUS_HINTS,
46 ADVICE_STATUS_U_OPTION,
47 ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
48 ADVICE_SUBMODULES_NOT_UPDATED,
49 ADVICE_UPDATE_SPARSE_PATH,
50 ADVICE_WAITING_FOR_EDITOR,
51 ADVICE_SKIPPED_CHERRY_PICKS,
54 int git_default_advice_config(const char *var, const char *value);
55 __attribute__((format (printf, 1, 2)))
56 void advise(const char *advice, ...);
58 /**
59 * Checks if advice type is enabled (can be printed to the user).
60 * Should be called before advise().
62 int advice_enabled(enum advice_type type);
64 /**
65 * Checks the visibility of the advice before printing.
67 __attribute__((format (printf, 2, 3)))
68 void advise_if_enabled(enum advice_type type, const char *advice, ...);
70 int error_resolve_conflict(const char *me);
71 void NORETURN die_resolve_conflict(const char *me);
72 void NORETURN die_conclude_merge(void);
73 void NORETURN die_ff_impossible(void);
74 void advise_on_updating_sparse_paths(struct string_list *pathspec_list);
75 void detach_advice(const char *new_name);
76 void advise_on_moving_dirty_path(struct string_list *pathspec_list);
78 #endif /* ADVICE_H */