6 /* Functions for acting on the information about branches. */
9 * Creates a new branch, where:
11 * - name is the new branch name
13 * - start_name is the name of the existing branch that the new branch should
16 * - force enables overwriting an existing (non-head) branch
18 * - clobber_head_ok allows the currently checked out (hence existing)
19 * branch to be overwritten; without 'force', it has no effect.
21 * - reflog creates a reflog for the branch
23 * - quiet suppresses tracking information
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).
29 void create_branch(const char *name
, const char *start_name
,
30 int force
, int clobber_head_ok
,
31 int reflog
, int quiet
, enum branch_track track
);
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.
38 extern int validate_branchname(const char *name
, struct strbuf
*ref
);
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.
46 extern int validate_new_branchname(const char *name
, struct strbuf
*ref
, int force
);
49 * Remove information about the state of working on the current
50 * branch. (E.g., MERGE_HEAD)
52 void remove_branch_state(void);
55 * Configure local branch "local" as downstream to branch "remote"
56 * from remote "origin". Used by git branch --set-upstream.
57 * Returns 0 on success.
59 #define BRANCH_CONFIG_VERBOSE 01
60 extern int install_branch_config(int flag
, const char *local
, const char *origin
, const char *remote
);
63 * Read branch description
65 extern int read_branch_desc(struct strbuf
*, const char *branch_name
);
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
72 extern void die_if_checked_out(const char *branch
, int ignore_current_worktree
);
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
79 extern int replace_each_worktree_head_symref(const char *oldref
, const char *newref
,