[thirdparty/git.git] / advice.h

#ifndef ADVICE_H
#define ADVICE_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_AMBIGUOUS_FETCH_REFSPEC,
	ADVICE_AM_WORK_DIR,
	ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
	ADVICE_COMMIT_BEFORE_MERGE,
	ADVICE_DETACHED_HEAD,
	ADVICE_DIVERGING,
	ADVICE_FETCH_SHOW_FORCED_UPDATES,
	ADVICE_FORCE_DELETE_BRANCH,
	ADVICE_GRAFT_FILE_DEPRECATED,
	ADVICE_IGNORED_HOOK,
	ADVICE_IMPLICIT_IDENTITY,
	ADVICE_MERGE_CONFLICT,
	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_REF_NEEDS_UPDATE,
	ADVICE_PUSH_UNQUALIFIED_REF_NAME,
	ADVICE_PUSH_UPDATE_REJECTED,
	ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
	ADVICE_REF_SYNTAX,
	ADVICE_RESET_NO_REFRESH_WARNING,
	ADVICE_RESOLVE_CONFLICT,
	ADVICE_RM_HINTS,
	ADVICE_SEQUENCER_IN_USE,
	ADVICE_SET_UPSTREAM_FAILURE,
	ADVICE_SKIPPED_CHERRY_PICKS,
	ADVICE_STATUS_AHEAD_BEHIND_WARNING,
	ADVICE_STATUS_HINTS,
	ADVICE_STATUS_U_OPTION,
	ADVICE_SUBMODULES_NOT_UPDATED,
	ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
	ADVICE_SUBMODULE_MERGE_CONFLICT,
	ADVICE_SUGGEST_DETACHING_HEAD,
	ADVICE_UPDATE_SPARSE_PATH,
	ADVICE_WAITING_FOR_EDITOR,
	ADVICE_WORKTREE_ADD_ORPHAN,
};

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);
void advise_on_moving_dirty_path(struct string_list *pathspec_list);

#endif /* ADVICE_H */
Commit	Line	Data
75194438 JK	1	#ifndef ADVICE_H
	2	#define ADVICE_H
	3
a20f7047 MT	4	struct string_list;
a20f7047 MT	5
b3b18d16 HW	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.
	12	*/
eddd134c	13	enum advice_type {
b3b18d16	14	ADVICE_ADD_EMBEDDED_REPO,
69290551 BB	15	ADVICE_ADD_EMPTY_PATHSPEC,
69290551 BB	16	ADVICE_ADD_IGNORED_FILE,
e4921d87	17	ADVICE_AMBIGUOUS_FETCH_REFSPEC,
3196029b	18	ADVICE_AM_WORK_DIR,
b3b18d16 HW	19	ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
	20	ADVICE_COMMIT_BEFORE_MERGE,
	21	ADVICE_DETACHED_HEAD,
765071a8	22	ADVICE_DIVERGING,
b3b18d16	23	ADVICE_FETCH_SHOW_FORCED_UPDATES,
bec9bb4b	24	ADVICE_FORCE_DELETE_BRANCH,
b3b18d16 HW	25	ADVICE_GRAFT_FILE_DEPRECATED,
	26	ADVICE_IGNORED_HOOK,
	27	ADVICE_IMPLICIT_IDENTITY,
ec030091	28	ADVICE_MERGE_CONFLICT,
b3b18d16 HW	29	ADVICE_NESTED_TAG,
	30	ADVICE_OBJECT_NAME_WARNING,
	31	ADVICE_PUSH_ALREADY_EXISTS,
	32	ADVICE_PUSH_FETCH_FIRST,
	33	ADVICE_PUSH_NEEDS_FORCE,
	34	ADVICE_PUSH_NON_FF_CURRENT,
	35	ADVICE_PUSH_NON_FF_MATCHING,
3196029b	36	ADVICE_PUSH_REF_NEEDS_UPDATE,
b3b18d16	37	ADVICE_PUSH_UNQUALIFIED_REF_NAME,
b3b18d16	38	ADVICE_PUSH_UPDATE_REJECTED,
3196029b	39	ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
8fbd903e	40	ADVICE_REF_SYNTAX,
9396251b	41	ADVICE_RESET_NO_REFRESH_WARNING,
b3b18d16 HW	42	ADVICE_RESOLVE_CONFLICT,
	43	ADVICE_RM_HINTS,
	44	ADVICE_SEQUENCER_IN_USE,
	45	ADVICE_SET_UPSTREAM_FAILURE,
3196029b	46	ADVICE_SKIPPED_CHERRY_PICKS,
b3b18d16 HW	47	ADVICE_STATUS_AHEAD_BEHIND_WARNING,
	48	ADVICE_STATUS_HINTS,
	49	ADVICE_STATUS_U_OPTION,
961b130d	50	ADVICE_SUBMODULES_NOT_UPDATED,
3196029b	51	ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
b9e55be7	52	ADVICE_SUBMODULE_MERGE_CONFLICT,
3196029b	53	ADVICE_SUGGEST_DETACHING_HEAD,
a20f7047	54	ADVICE_UPDATE_SPARSE_PATH,
b3b18d16	55	ADVICE_WAITING_FOR_EDITOR,
35f0383c	56	ADVICE_WORKTREE_ADD_ORPHAN,
b3b18d16 HW	57	};
b3b18d16 HW	58
75194438	59	int git_default_advice_config(const char var, const char value);
4621085b	60	__attribute__((format (printf, 1, 2)))
38ef61cf	61	void advise(const char *advice, ...);
b3b18d16 HW	62
	63	/**
	64	* Checks if advice type is enabled (can be printed to the user).
	65	* Should be called before advise().
	66	*/
	67	int advice_enabled(enum advice_type type);
	68
	69	/**
	70	* Checks the visibility of the advice before printing.
	71	*/
927dc330	72	__attribute__((format (printf, 2, 3)))
b3b18d16 HW	73	void advise_if_enabled(enum advice_type type, const char *advice, ...);
b3b18d16 HW	74
38ef61cf	75	int error_resolve_conflict(const char *me);
55454427	76	void NORETURN die_resolve_conflict(const char *me);
4a4cf9e8	77	void NORETURN die_conclude_merge(void);
3d5fc24d	78	void NORETURN die_ff_impossible(void);
a20f7047	79	void advise_on_updating_sparse_paths(struct string_list *pathspec_list);
2857093b	80	void detach_advice(const char *new_name);
5efd533e	81	void advise_on_moving_dirty_path(struct string_list *pathspec_list);
d38a30df	82
75194438	83	#endif /* ADVICE_H */