blob: bc2432980a83d570ea1179ebb5d25c93e94dc238 [file] [log] [blame]
Jeff King75194432009-09-09 07:38:58 -04001#ifndef ADVICE_H
2#define ADVICE_H
3
Matthieu Moyd38a30d2010-01-12 10:54:44 +01004#include "git-compat-util.h"
5
Derrick Stolee377444b2019-06-18 13:25:27 -07006extern int advice_fetch_show_forced_updates;
Chris Rorvick11845642012-12-02 21:27:50 -06007extern int advice_push_update_rejected;
Christopher Tiwaldf25950f2012-03-20 00:31:33 -04008extern int advice_push_non_ff_current;
Christopher Tiwaldf25950f2012-03-20 00:31:33 -04009extern int advice_push_non_ff_matching;
Chris Rorvickb4505682012-12-02 21:27:51 -060010extern int advice_push_already_exists;
Junio C Hamano75e5c0d2013-01-23 13:55:30 -080011extern int advice_push_fetch_first;
12extern int advice_push_needs_force;
Ævar Arnfjörð Bjarmasondd8dd302018-11-13 19:52:43 +000013extern int advice_push_unqualified_ref_name;
Srinidhi Kaushik3b990aa2020-10-03 17:40:45 +053014extern int advice_push_ref_needs_update;
Jeff Kingedf563f2009-09-09 07:43:03 -040015extern int advice_status_hints;
Nguyễn Thái Ngọc Duy6a38ef22013-03-13 19:59:16 +070016extern int advice_status_u_option;
Jeff Hostetler0a535612019-06-18 13:21:27 -070017extern int advice_status_ahead_behind_warning;
Matthieu Moy4c371f92009-11-22 23:26:17 +010018extern int advice_commit_before_merge;
Ben Peart649bf3a2018-10-23 15:04:23 -040019extern int advice_reset_quiet_warning;
Matthieu Moyd38a30d2010-01-12 10:54:44 +010020extern int advice_resolve_conflict;
Rohit Ashiwal6a1f9042019-07-02 14:41:25 +053021extern int advice_sequencer_in_use;
Jeff Kingb706fcf2010-01-13 15:17:08 -050022extern int advice_implicit_identity;
Junio C Hamano13be3e32010-01-29 22:03:24 -080023extern int advice_detached_head;
Jeff Kingcaa20362013-04-02 15:05:12 -040024extern int advice_set_upstream_failure;
Nguyễn Thái Ngọc Duy798c35f2013-05-29 19:12:42 +070025extern int advice_object_name_warning;
Nguyễn Thái Ngọc Duy431bb232018-05-26 15:55:27 +020026extern int advice_amworkdir;
Mathieu Lienard--Mayor7e309442013-06-12 10:06:44 +020027extern int advice_rm_hints;
Jeff King53213992017-06-14 06:58:22 -040028extern int advice_add_embedded_repo;
Damien Mariéf805a002017-10-06 08:07:55 +000029extern int advice_ignored_hook;
Lars Schneiderabfb04d2017-12-07 16:16:41 +010030extern int advice_waiting_for_editor;
Johannes Schindelinf9f99b32018-04-29 00:44:44 +020031extern int advice_graft_file_deprecated;
Ævar Arnfjörð Bjarmasonad8d5102018-06-05 14:40:48 +000032extern int advice_checkout_ambiguous_remote_branch_name;
Jonathan Tan4f3e57e2019-12-02 11:57:52 -080033extern int advice_submodule_alternate_error_strategy_die;
Heba Waly887a0fd2020-02-06 23:57:30 +130034extern int advice_add_ignored_file;
35extern int advice_add_empty_pathspec;
Jeff King75194432009-09-09 07:38:58 -040036
Heba Walyb3b18d12020-03-02 20:01:59 +000037/*
38 * To add a new advice, you need to:
39 * Define a new advice_type.
40 * Add a new entry to advice_setting array.
41 * Add the new config variable to Documentation/config/advice.txt.
42 * Call advise_if_enabled to print your advice.
43 */
44 enum advice_type {
45 ADVICE_ADD_EMBEDDED_REPO,
46 ADVICE_AM_WORK_DIR,
47 ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
48 ADVICE_COMMIT_BEFORE_MERGE,
49 ADVICE_DETACHED_HEAD,
50 ADVICE_FETCH_SHOW_FORCED_UPDATES,
51 ADVICE_GRAFT_FILE_DEPRECATED,
52 ADVICE_IGNORED_HOOK,
53 ADVICE_IMPLICIT_IDENTITY,
54 ADVICE_NESTED_TAG,
55 ADVICE_OBJECT_NAME_WARNING,
56 ADVICE_PUSH_ALREADY_EXISTS,
57 ADVICE_PUSH_FETCH_FIRST,
58 ADVICE_PUSH_NEEDS_FORCE,
59 ADVICE_PUSH_NON_FF_CURRENT,
60 ADVICE_PUSH_NON_FF_MATCHING,
61 ADVICE_PUSH_UNQUALIFIED_REF_NAME,
62 ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
63 ADVICE_PUSH_UPDATE_REJECTED,
Srinidhi Kaushik3b990aa2020-10-03 17:40:45 +053064 ADVICE_PUSH_REF_NEEDS_UPDATE,
Heba Walyb3b18d12020-03-02 20:01:59 +000065 ADVICE_RESET_QUIET_WARNING,
66 ADVICE_RESOLVE_CONFLICT,
67 ADVICE_RM_HINTS,
68 ADVICE_SEQUENCER_IN_USE,
69 ADVICE_SET_UPSTREAM_FAILURE,
70 ADVICE_STATUS_AHEAD_BEHIND_WARNING,
71 ADVICE_STATUS_HINTS,
72 ADVICE_STATUS_U_OPTION,
73 ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
74 ADVICE_WAITING_FOR_EDITOR,
75};
76
Jeff King75194432009-09-09 07:38:58 -040077int git_default_advice_config(const char *var, const char *value);
Jeff King46210852013-07-09 20:18:40 -040078__attribute__((format (printf, 1, 2)))
Ramkumar Ramachandra38ef61c2011-08-04 16:08:59 +053079void advise(const char *advice, ...);
Heba Walyb3b18d12020-03-02 20:01:59 +000080
81/**
82 * Checks if advice type is enabled (can be printed to the user).
83 * Should be called before advise().
84 */
85int advice_enabled(enum advice_type type);
86
87/**
88 * Checks the visibility of the advice before printing.
89 */
90void advise_if_enabled(enum advice_type type, const char *advice, ...);
91
Ramkumar Ramachandra38ef61c2011-08-04 16:08:59 +053092int error_resolve_conflict(const char *me);
Denton Liu55454422019-04-29 04:28:14 -040093void NORETURN die_resolve_conflict(const char *me);
Paul Tan4a4cf9e2015-06-18 18:54:04 +080094void NORETURN die_conclude_merge(void);
Nguyễn Thái Ngọc Duy28570932012-01-16 16:46:16 +070095void detach_advice(const char *new_name);
Matthieu Moyd38a30d2010-01-12 10:54:44 +010096
Jeff King75194432009-09-09 07:38:58 -040097#endif /* ADVICE_H */