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