Fifth batch for 2.19 cycle
[git/git.git] / branch.h
CommitLineData
e496c003
DB
1#ifndef BRANCH_H
2#define BRANCH_H
3
c369e7b8
DB
4/* Functions for acting on the information about branches. */
5
6/*
4bd488ea
JK
7 * Creates a new branch, where:
8 *
9 * - name is the new branch name
10 *
11 * - start_name is the name of the existing branch that the new branch should
12 * start from
13 *
14 * - force enables overwriting an existing (non-head) branch
15 *
f6cea74d
KS
16 * - clobber_head_ok allows the currently checked out (hence existing)
17 * branch to be overwritten; without 'force', it has no effect.
18 *
4bd488ea
JK
19 * - reflog creates a reflog for the branch
20 *
f6cea74d
KS
21 * - quiet suppresses tracking information
22 *
4bd488ea
JK
23 * - track causes the new branch to be configured to merge the remote branch
24 * that start_name is a tracking branch for (if any).
e2bbd0cc 25 *
c369e7b8 26 */
4bd488ea 27void create_branch(const char *name, const char *start_name,
e2bbd0cc
KS
28 int force, int clobber_head_ok,
29 int reflog, int quiet, enum branch_track track);
e496c003 30
55c4a673 31/*
bc1c9c0e
JH
32 * Check if 'name' can be a valid name for a branch; die otherwise.
33 * Return 1 if the named branch already exists; return 0 otherwise.
34 * Fill ref with the full refname for the branch.
35 */
36extern int validate_branchname(const char *name, struct strbuf *ref);
37
38/*
39 * Check if a branch 'name' can be created as a new branch; die otherwise.
40 * 'force' can be used when it is OK for the named branch already exists.
41 * Return 1 if the named branch already exists; return 0 otherwise.
42 * Fill ref with the full refname for the branch.
55c4a673 43 */
bc1c9c0e 44extern int validate_new_branchname(const char *name, struct strbuf *ref, int force);
55c4a673 45
c369e7b8
DB
46/*
47 * Remove information about the state of working on the current
48 * branch. (E.g., MERGE_HEAD)
49 */
50void remove_branch_state(void);
51
a9f2c136 52/*
13931236
MM
53 * Configure local branch "local" as downstream to branch "remote"
54 * from remote "origin". Used by git branch --set-upstream.
27852b2c 55 * Returns 0 on success.
a9f2c136
JH
56 */
57#define BRANCH_CONFIG_VERBOSE 01
27852b2c 58extern int install_branch_config(int flag, const char *local, const char *origin, const char *remote);
a9f2c136 59
6f9a3321
JH
60/*
61 * Read branch description
62 */
63extern int read_branch_desc(struct strbuf *, const char *branch_name);
64
ed89f84b
ES
65/*
66 * Check if a branch is checked out in the main worktree or any linked
67 * worktree and die (with a message describing its checkout location) if
68 * it is.
69 */
8d9fdd70 70extern void die_if_checked_out(const char *branch, int ignore_current_worktree);
ed89f84b 71
70999e9c
KY
72/*
73 * Update all per-worktree HEADs pointing at the old ref to point the new ref.
74 * This will be used when renaming a branch. Returns 0 if successful, non-zero
75 * otherwise.
76 */
39ee4c6c
KM
77extern int replace_each_worktree_head_symref(const char *oldref, const char *newref,
78 const char *logmsg);
70999e9c 79
e496c003 80#endif