advice.h

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