Blame - branch.h - external/github.com/git/git

blob: 560b6b96a8f307baac31ea699321e17ed2c22dbe [file] [log] [blame]

Daniel Barkalow	e496c00	2008-02-07 16:40:08	[diff] [blame]	1	#ifndef BRANCH_H
				2	#define BRANCH_H
				3
Nguyễn Thái Ngọc Duy	4edce17	2018-11-10 05:49:00	[diff] [blame]	4	struct repository;
Elijah Newren	ef3ca95	2018-08-15 17:54:05	[diff] [blame]	5	struct strbuf;
				6
Elijah Newren	e730b81	2018-08-15 17:54:07	[diff] [blame]	7	enum branch_track {
				8	BRANCH_TRACK_UNSPECIFIED = -1,
				9	BRANCH_TRACK_NEVER = 0,
				10	BRANCH_TRACK_REMOTE,
				11	BRANCH_TRACK_ALWAYS,
				12	BRANCH_TRACK_EXPLICIT,
Josh Steadmon	d311566	2021-12-21 03:30:23	[diff] [blame]	13	BRANCH_TRACK_OVERRIDE,
				14	BRANCH_TRACK_INHERIT,
Tao Klerks	bdaf1df	2022-04-29 09:56:44	[diff] [blame]	15	BRANCH_TRACK_SIMPLE,
Elijah Newren	e730b81	2018-08-15 17:54:07	[diff] [blame]	16	};
				17
				18	extern enum branch_track git_branch_track;
				19
Daniel Barkalow	c369e7b	2008-02-07 16:40:16	[diff] [blame]	20	/* Functions for acting on the information about branches. */
				21
Glen Choo	e89f151	2022-01-29 00:04:41	[diff] [blame]	22	/**
				23	* Sets branch.<new_ref>.{remote,merge} config settings such that
				24	* new_ref tracks orig_ref according to the specified tracking mode.
				25	*
				26	* - new_ref is the name of the branch that we are setting tracking
				27	* for.
				28	*
				29	* - orig_ref is the name of the ref that is 'upstream' of new_ref.
				30	* orig_ref will be expanded with DWIM so that the config settings
				31	* are in the correct format e.g. "refs/remotes/origin/main" instead
				32	* of "origin/main".
				33	*
				34	* - track is the tracking mode e.g. BRANCH_TRACK_REMOTE causes
				35	* new_ref to track orig_ref directly, whereas BRANCH_TRACK_INHERIT
				36	* causes new_ref to track whatever orig_ref tracks.
				37	*
				38	* - quiet suppresses tracking information.
				39	*/
				40	void dwim_and_setup_tracking(struct repository r, const char new_ref,
				41	const char *orig_ref, enum branch_track track,
				42	int quiet);
				43
Daniel Barkalow	c369e7b	2008-02-07 16:40:16	[diff] [blame]	44	/*
Jeff King	4bd488e	2016-11-04 16:30:12	[diff] [blame]	45	* Creates a new branch, where:
				46	*
Nguyễn Thái Ngọc Duy	4edce17	2018-11-10 05:49:00	[diff] [blame]	47	* - r is the repository to add a branch to
				48	*
Jeff King	4bd488e	2016-11-04 16:30:12	[diff] [blame]	49	* - name is the new branch name
				50	*
				51	* - start_name is the name of the existing branch that the new branch should
				52	* start from
				53	*
				54	* - force enables overwriting an existing (non-head) branch
				55	*
Glen Choo	bc0893c	2022-01-29 00:04:42	[diff] [blame]	56	* - clobber_head_ok, when enabled with 'force', allows the currently
				57	* checked out (head) branch to be overwritten
Kaartic Sivaraam	f6cea74	2017-11-18 17:26:45	[diff] [blame]	58	*
Jeff King	4bd488e	2016-11-04 16:30:12	[diff] [blame]	59	* - reflog creates a reflog for the branch
				60	*
Kaartic Sivaraam	f6cea74	2017-11-18 17:26:45	[diff] [blame]	61	* - quiet suppresses tracking information
				62	*
Jeff King	4bd488e	2016-11-04 16:30:12	[diff] [blame]	63	* - track causes the new branch to be configured to merge the remote branch
				64	* that start_name is a tracking branch for (if any).
Kaartic Sivaraam	e2bbd0c	2017-11-18 17:26:46	[diff] [blame]	65	*
Glen Choo	3f3e760	2022-01-29 00:04:43	[diff] [blame]	66	* - dry_run causes the branch to be validated but not created.
				67	*
Daniel Barkalow	c369e7b	2008-02-07 16:40:16	[diff] [blame]	68	*/
Nguyễn Thái Ngọc Duy	4edce17	2018-11-10 05:49:00	[diff] [blame]	69	void create_branch(struct repository *r,
				70	const char name, const char start_name,
Kaartic Sivaraam	e2bbd0c	2017-11-18 17:26:46	[diff] [blame]	71	int force, int clobber_head_ok,
Glen Choo	3f3e760	2022-01-29 00:04:43	[diff] [blame]	72	int reflog, int quiet, enum branch_track track,
				73	int dry_run);
Daniel Barkalow	e496c00	2008-02-07 16:40:08	[diff] [blame]	74
Daniel Barkalow	c369e7b	2008-02-07 16:40:16	[diff] [blame]	75	/*
Glen Choo	961b130	2022-01-29 00:04:45	[diff] [blame]	76	* Creates a new branch in a repository and its submodules (and its
				77	* submodules, recursively). The parameters are mostly analogous to
				78	* those of create_branch() except for start_name, which is represented
				79	* by two different parameters:
				80	*
				81	* - start_commitish is the commit-ish, in repository r, that determines
				82	* which commits the branches will point to. The superproject branch
				83	* will point to the commit of start_commitish and the submodule
				84	* branches will point to the gitlink commit oids in start_commitish's
				85	* tree.
				86	*
				87	* - tracking_name is the name of the ref, in repository r, that will be
				88	* used to set up tracking information. This value is propagated to
				89	* all submodules, which will evaluate the ref using their own ref
				90	* stores. If NULL, this defaults to start_commitish.
				91	*
				92	* When this function is called on the superproject, start_commitish
				93	* can be any user-provided ref and tracking_name can be NULL (similar
				94	* to create_branches()). But when recursing through submodules,
				95	* start_commitish is the plain gitlink commit oid. Since the oid cannot
				96	* be used for tracking information, tracking_name is propagated and
				97	* used for tracking instead.
				98	*/
				99	void create_branches_recursively(struct repository r, const char name,
				100	const char *start_commitish,
				101	const char *tracking_name, int force,
				102	int reflog, int quiet, enum branch_track track,
				103	int dry_run);
				104	/*
Junio C Hamano	bc1c9c0	2017-10-13 04:45:40	[diff] [blame]	105	* Check if 'name' can be a valid name for a branch; die otherwise.
				106	* Return 1 if the named branch already exists; return 0 otherwise.
				107	* Fill ref with the full refname for the branch.
Conrad Irwin	55c4a67	2011-08-20 21:49:48	[diff] [blame]	108	*/
Denton Liu	5545442	2019-04-29 08:28:14	[diff] [blame]	109	int validate_branchname(const char name, struct strbuf ref);
Junio C Hamano	bc1c9c0	2017-10-13 04:45:40	[diff] [blame]	110
				111	/*
				112	* Check if a branch 'name' can be created as a new branch; die otherwise.
				113	* 'force' can be used when it is OK for the named branch already exists.
				114	* Return 1 if the named branch already exists; return 0 otherwise.
				115	* Fill ref with the full refname for the branch.
				116	*/
Denton Liu	5545442	2019-04-29 08:28:14	[diff] [blame]	117	int validate_new_branchname(const char name, struct strbuf ref, int force);
Conrad Irwin	55c4a67	2011-08-20 21:49:48	[diff] [blame]	118
				119	/*
Nguyễn Thái Ngọc Duy	b643355	2019-05-09 10:10:27	[diff] [blame]	120	* Remove information about the merge state on the current
				121	* branch. (E.g., MERGE_HEAD)
				122	*/
				123	void remove_merge_branch_state(struct repository *r);
				124
				125	/*
Daniel Barkalow	c369e7b	2008-02-07 16:40:16	[diff] [blame]	126	* Remove information about the state of working on the current
				127	* branch. (E.g., MERGE_HEAD)
				128	*/
Nguyễn Thái Ngọc Duy	f4a4b9a	2019-03-29 10:38:59	[diff] [blame]	129	void remove_branch_state(struct repository *r, int verbose);
Daniel Barkalow	c369e7b	2008-02-07 16:40:16	[diff] [blame]	130
Junio C Hamano	a9f2c13	2009-03-04 06:29:55	[diff] [blame]	131	/*
Matthieu Moy	1393123	2010-11-02 15:31:25	[diff] [blame]	132	* Configure local branch "local" as downstream to branch "remote"
				133	* from remote "origin". Used by git branch --set-upstream.
Patrick Steinhardt	27852b2	2016-02-22 11:23:23	[diff] [blame]	134	* Returns 0 on success.
Junio C Hamano	a9f2c13	2009-03-04 06:29:55	[diff] [blame]	135	*/
				136	#define BRANCH_CONFIG_VERBOSE 01
Denton Liu	5545442	2019-04-29 08:28:14	[diff] [blame]	137	int install_branch_config(int flag, const char local, const char origin, const char *remote);
Junio C Hamano	a9f2c13	2009-03-04 06:29:55	[diff] [blame]	138
Junio C Hamano	6f9a332	2011-09-22 03:19:38	[diff] [blame]	139	/*
				140	* Read branch description
				141	*/
Denton Liu	5545442	2019-04-29 08:28:14	[diff] [blame]	142	int read_branch_desc(struct strbuf , const char branch_name);
Junio C Hamano	6f9a332	2011-09-22 03:19:38	[diff] [blame]	143
Eric Sunshine	ed89f84	2015-07-17 23:00:04	[diff] [blame]	144	/*
				145	* Check if a branch is checked out in the main worktree or any linked
				146	* worktree and die (with a message describing its checkout location) if
				147	* it is.
				148	*/
Denton Liu	5545442	2019-04-29 08:28:14	[diff] [blame]	149	void die_if_checked_out(const char *branch, int ignore_current_worktree);
Eric Sunshine	ed89f84	2015-07-17 23:00:04	[diff] [blame]	150
Kazuki Yamaguchi	70999e9	2016-03-27 14:37:14	[diff] [blame]	151	/*
				152	* Update all per-worktree HEADs pointing at the old ref to point the new ref.
				153	* This will be used when renaming a branch. Returns 0 if successful, non-zero
				154	* otherwise.
				155	*/
Denton Liu	5545442	2019-04-29 08:28:14	[diff] [blame]	156	int replace_each_worktree_head_symref(const char oldref, const char newref,
Denton Liu	ad6dad0	2019-04-29 08:28:23	[diff] [blame]	157	const char *logmsg);
Kazuki Yamaguchi	70999e9	2016-03-27 14:37:14	[diff] [blame]	158
Daniel Barkalow	e496c00	2008-02-07 16:40:08	[diff] [blame]	159	#endif