blob: df0be61506fd36a0bfb63a911ba532b5db495767 [file] [log] [blame]
Daniel Barkalowe496c002008-02-07 11:40:08 -05001#ifndef BRANCH_H
2#define BRANCH_H
3
Nguyễn Thái Ngọc Duy4edce172018-11-10 06:49:00 +01004struct repository;
Elijah Newrenef3ca952018-08-15 10:54:05 -07005struct strbuf;
6
Elijah Newrene730b812018-08-15 10:54:07 -07007enum branch_track {
8 BRANCH_TRACK_UNSPECIFIED = -1,
9 BRANCH_TRACK_NEVER = 0,
10 BRANCH_TRACK_REMOTE,
11 BRANCH_TRACK_ALWAYS,
12 BRANCH_TRACK_EXPLICIT,
13 BRANCH_TRACK_OVERRIDE
14};
15
16extern enum branch_track git_branch_track;
17
Daniel Barkalowc369e7b2008-02-07 11:40:16 -050018/* Functions for acting on the information about branches. */
19
20/*
Jeff King4bd488e2016-11-04 12:30:12 -040021 * Creates a new branch, where:
22 *
Nguyễn Thái Ngọc Duy4edce172018-11-10 06:49:00 +010023 * - r is the repository to add a branch to
24 *
Jeff King4bd488e2016-11-04 12:30:12 -040025 * - name is the new branch name
26 *
27 * - start_name is the name of the existing branch that the new branch should
28 * start from
29 *
30 * - force enables overwriting an existing (non-head) branch
31 *
Kaartic Sivaraamf6cea742017-11-18 22:56:45 +053032 * - clobber_head_ok allows the currently checked out (hence existing)
33 * branch to be overwritten; without 'force', it has no effect.
34 *
Jeff King4bd488e2016-11-04 12:30:12 -040035 * - reflog creates a reflog for the branch
36 *
Kaartic Sivaraamf6cea742017-11-18 22:56:45 +053037 * - quiet suppresses tracking information
38 *
Jeff King4bd488e2016-11-04 12:30:12 -040039 * - track causes the new branch to be configured to merge the remote branch
40 * that start_name is a tracking branch for (if any).
Kaartic Sivaraame2bbd0c2017-11-18 22:56:46 +053041 *
Daniel Barkalowc369e7b2008-02-07 11:40:16 -050042 */
Nguyễn Thái Ngọc Duy4edce172018-11-10 06:49:00 +010043void create_branch(struct repository *r,
44 const char *name, const char *start_name,
Kaartic Sivaraame2bbd0c2017-11-18 22:56:46 +053045 int force, int clobber_head_ok,
46 int reflog, int quiet, enum branch_track track);
Daniel Barkalowe496c002008-02-07 11:40:08 -050047
Daniel Barkalowc369e7b2008-02-07 11:40:16 -050048/*
Junio C Hamanobc1c9c02017-10-13 13:45:40 +090049 * Check if 'name' can be a valid name for a branch; die otherwise.
50 * Return 1 if the named branch already exists; return 0 otherwise.
51 * Fill ref with the full refname for the branch.
Conrad Irwin55c4a672011-08-20 14:49:48 -070052 */
Denton Liu55454422019-04-29 04:28:14 -040053int validate_branchname(const char *name, struct strbuf *ref);
Junio C Hamanobc1c9c02017-10-13 13:45:40 +090054
55/*
56 * Check if a branch 'name' can be created as a new branch; die otherwise.
57 * 'force' can be used when it is OK for the named branch already exists.
58 * Return 1 if the named branch already exists; return 0 otherwise.
59 * Fill ref with the full refname for the branch.
60 */
Denton Liu55454422019-04-29 04:28:14 -040061int validate_new_branchname(const char *name, struct strbuf *ref, int force);
Conrad Irwin55c4a672011-08-20 14:49:48 -070062
63/*
Nguyễn Thái Ngọc Duyb6433552019-05-09 17:10:27 +070064 * Remove information about the merge state on the current
65 * branch. (E.g., MERGE_HEAD)
66 */
67void remove_merge_branch_state(struct repository *r);
68
69/*
Daniel Barkalowc369e7b2008-02-07 11:40:16 -050070 * Remove information about the state of working on the current
71 * branch. (E.g., MERGE_HEAD)
72 */
Nguyễn Thái Ngọc Duyf4a4b9a2019-03-29 17:38:59 +070073void remove_branch_state(struct repository *r, int verbose);
Daniel Barkalowc369e7b2008-02-07 11:40:16 -050074
Junio C Hamanoa9f2c132009-03-03 22:29:55 -080075/*
Matthieu Moy13931232010-11-02 16:31:25 +010076 * Configure local branch "local" as downstream to branch "remote"
77 * from remote "origin". Used by git branch --set-upstream.
Patrick Steinhardt27852b22016-02-22 12:23:23 +010078 * Returns 0 on success.
Junio C Hamanoa9f2c132009-03-03 22:29:55 -080079 */
80#define BRANCH_CONFIG_VERBOSE 01
Denton Liu55454422019-04-29 04:28:14 -040081int install_branch_config(int flag, const char *local, const char *origin, const char *remote);
Junio C Hamanoa9f2c132009-03-03 22:29:55 -080082
Junio C Hamano6f9a3322011-09-21 20:19:38 -070083/*
84 * Read branch description
85 */
Denton Liu55454422019-04-29 04:28:14 -040086int read_branch_desc(struct strbuf *, const char *branch_name);
Junio C Hamano6f9a3322011-09-21 20:19:38 -070087
Eric Sunshineed89f842015-07-17 19:00:04 -040088/*
89 * Check if a branch is checked out in the main worktree or any linked
90 * worktree and die (with a message describing its checkout location) if
91 * it is.
92 */
Denton Liu55454422019-04-29 04:28:14 -040093void die_if_checked_out(const char *branch, int ignore_current_worktree);
Eric Sunshineed89f842015-07-17 19:00:04 -040094
Kazuki Yamaguchi70999e92016-03-27 23:37:14 +090095/*
96 * Update all per-worktree HEADs pointing at the old ref to point the new ref.
97 * This will be used when renaming a branch. Returns 0 if successful, non-zero
98 * otherwise.
99 */
Denton Liu55454422019-04-29 04:28:14 -0400100int replace_each_worktree_head_symref(const char *oldref, const char *newref,
Denton Liuad6dad02019-04-29 04:28:23 -0400101 const char *logmsg);
Kazuki Yamaguchi70999e92016-03-27 23:37:14 +0900102
Daniel Barkalowe496c002008-02-07 11:40:08 -0500103#endif