[thirdparty/git.git] / advice.h

#ifndef ADVICE_H
#define ADVICE_H

#include "git-compat-util.h"

struct string_list;

/*
 * To add a new advice, you need to:
 * Define a new advice_type.
 * Add a new entry to advice_setting array.
 * Add the new config variable to Documentation/config/advice.txt.
 * Call advise_if_enabled to print your advice.
 */
 enum advice_type {
	ADVICE_ADD_EMBEDDED_REPO,
	ADVICE_ADD_EMPTY_PATHSPEC,
	ADVICE_ADD_IGNORED_FILE,
	ADVICE_AM_WORK_DIR,
	ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
	ADVICE_COMMIT_BEFORE_MERGE,
	ADVICE_DETACHED_HEAD,
	ADVICE_FETCH_SHOW_FORCED_UPDATES,
	ADVICE_GRAFT_FILE_DEPRECATED,
	ADVICE_IGNORED_HOOK,
	ADVICE_IMPLICIT_IDENTITY,
	ADVICE_NESTED_TAG,
	ADVICE_OBJECT_NAME_WARNING,
	ADVICE_PUSH_ALREADY_EXISTS,
	ADVICE_PUSH_FETCH_FIRST,
	ADVICE_PUSH_NEEDS_FORCE,
	ADVICE_PUSH_NON_FF_CURRENT,
	ADVICE_PUSH_NON_FF_MATCHING,
	ADVICE_PUSH_UNQUALIFIED_REF_NAME,
	ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
	ADVICE_PUSH_UPDATE_REJECTED,
	ADVICE_PUSH_REF_NEEDS_UPDATE,
	ADVICE_RESET_QUIET_WARNING,
	ADVICE_RESOLVE_CONFLICT,
	ADVICE_RM_HINTS,
	ADVICE_SEQUENCER_IN_USE,
	ADVICE_SET_UPSTREAM_FAILURE,
	ADVICE_STATUS_AHEAD_BEHIND_WARNING,
	ADVICE_STATUS_HINTS,
	ADVICE_STATUS_U_OPTION,
	ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
	ADVICE_UPDATE_SPARSE_PATH,
	ADVICE_WAITING_FOR_EDITOR,
	ADVICE_SKIPPED_CHERRY_PICKS,
};

int git_default_advice_config(const char *var, const char *value);
__attribute__((format (printf, 1, 2)))
void advise(const char *advice, ...);

/**
 * Checks if advice type is enabled (can be printed to the user).
 * Should be called before advise().
 */
int advice_enabled(enum advice_type type);

/**
 * Checks the visibility of the advice before printing.
 */
__attribute__((format (printf, 2, 3)))
void advise_if_enabled(enum advice_type type, const char *advice, ...);

int error_resolve_conflict(const char *me);
void NORETURN die_resolve_conflict(const char *me);
void NORETURN die_conclude_merge(void);
void NORETURN die_ff_impossible(void);
void advise_on_updating_sparse_paths(struct string_list *pathspec_list);
void detach_advice(const char *new_name);

#endif /* ADVICE_H */
Commit	Line	Data
75194438 JK	1	#ifndef ADVICE_H
	2	#define ADVICE_H
	3
d38a30df MM	4	#include "git-compat-util.h"
d38a30df MM	5
a20f7047 MT	6	struct string_list;
a20f7047 MT	7
b3b18d16 HW	8	/*
	9	* To add a new advice, you need to:
	10	* Define a new advice_type.
	11	* Add a new entry to advice_setting array.
	12	* Add the new config variable to Documentation/config/advice.txt.
	13	* Call advise_if_enabled to print your advice.
	14	*/
	15	enum advice_type {
	16	ADVICE_ADD_EMBEDDED_REPO,
69290551 BB	17	ADVICE_ADD_EMPTY_PATHSPEC,
69290551 BB	18	ADVICE_ADD_IGNORED_FILE,
b3b18d16 HW	19	ADVICE_AM_WORK_DIR,
	20	ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
	21	ADVICE_COMMIT_BEFORE_MERGE,
	22	ADVICE_DETACHED_HEAD,
	23	ADVICE_FETCH_SHOW_FORCED_UPDATES,
	24	ADVICE_GRAFT_FILE_DEPRECATED,
	25	ADVICE_IGNORED_HOOK,
	26	ADVICE_IMPLICIT_IDENTITY,
	27	ADVICE_NESTED_TAG,
	28	ADVICE_OBJECT_NAME_WARNING,
	29	ADVICE_PUSH_ALREADY_EXISTS,
	30	ADVICE_PUSH_FETCH_FIRST,
	31	ADVICE_PUSH_NEEDS_FORCE,
	32	ADVICE_PUSH_NON_FF_CURRENT,
	33	ADVICE_PUSH_NON_FF_MATCHING,
	34	ADVICE_PUSH_UNQUALIFIED_REF_NAME,
	35	ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
	36	ADVICE_PUSH_UPDATE_REJECTED,
3b990aa6	37	ADVICE_PUSH_REF_NEEDS_UPDATE,
b3b18d16 HW	38	ADVICE_RESET_QUIET_WARNING,
	39	ADVICE_RESOLVE_CONFLICT,
	40	ADVICE_RM_HINTS,
	41	ADVICE_SEQUENCER_IN_USE,
	42	ADVICE_SET_UPSTREAM_FAILURE,
	43	ADVICE_STATUS_AHEAD_BEHIND_WARNING,
	44	ADVICE_STATUS_HINTS,
	45	ADVICE_STATUS_U_OPTION,
	46	ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
a20f7047	47	ADVICE_UPDATE_SPARSE_PATH,
b3b18d16	48	ADVICE_WAITING_FOR_EDITOR,
767a4ca6	49	ADVICE_SKIPPED_CHERRY_PICKS,
b3b18d16 HW	50	};
b3b18d16 HW	51
75194438	52	int git_default_advice_config(const char var, const char value);
4621085b	53	__attribute__((format (printf, 1, 2)))
38ef61cf	54	void advise(const char *advice, ...);
b3b18d16 HW	55
	56	/**
	57	* Checks if advice type is enabled (can be printed to the user).
	58	* Should be called before advise().
	59	*/
	60	int advice_enabled(enum advice_type type);
	61
	62	/**
	63	* Checks the visibility of the advice before printing.
	64	*/
927dc330	65	__attribute__((format (printf, 2, 3)))
b3b18d16 HW	66	void advise_if_enabled(enum advice_type type, const char *advice, ...);
b3b18d16 HW	67
38ef61cf	68	int error_resolve_conflict(const char *me);
55454427	69	void NORETURN die_resolve_conflict(const char *me);
4a4cf9e8	70	void NORETURN die_conclude_merge(void);
3d5fc24d	71	void NORETURN die_ff_impossible(void);
a20f7047	72	void advise_on_updating_sparse_paths(struct string_list *pathspec_list);
2857093b	73	void detach_advice(const char *new_name);
d38a30df	74
75194438	75	#endif /* ADVICE_H */