Merge branch 'bk/ancestry-path' into jc/branch-desc
[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/*
7 * Creates a new branch, where head is the branch currently checked
8 * out, name is the new branch name, start_name is the name of the
9 * existing branch that the new branch should start from, force
10 * enables overwriting an existing (non-head) branch, reflog creates a
11 * reflog for the branch, and track causes the new branch to be
12 * configured to merge the remote branch that start_name is a tracking
13 * branch for (if any).
14 */
15void create_branch(const char *head, const char *name, const char *start_name,
9ed36cfa 16 int force, int reflog, enum branch_track track);
e496c003 17
55c4a673
CI
18/*
19 * Validates that the requested branch may be created, returning the
20 * interpreted ref in ref, force indicates whether (non-head) branches
21 * may be overwritten. A non-zero return value indicates that the force
22 * parameter was non-zero and the branch already exists.
fa799376
JH
23 *
24 * Contrary to all of the above, when attr_only is 1, the caller is
25 * not interested in verifying if it is Ok to update the named
26 * branch to point at a potentially different commit. It is merely
27 * asking if it is OK to change some attribute for the named branch
28 * (e.g. tracking upstream).
29 *
30 * NEEDSWORK: This needs to be split into two separate functions in the
31 * longer run for sanity.
32 *
55c4a673 33 */
fa799376 34int validate_new_branchname(const char *name, struct strbuf *ref, int force, int attr_only);
55c4a673 35
c369e7b8
DB
36/*
37 * Remove information about the state of working on the current
38 * branch. (E.g., MERGE_HEAD)
39 */
40void remove_branch_state(void);
41
a9f2c136 42/*
13931236
MM
43 * Configure local branch "local" as downstream to branch "remote"
44 * from remote "origin". Used by git branch --set-upstream.
a9f2c136
JH
45 */
46#define BRANCH_CONFIG_VERBOSE 01
47extern void install_branch_config(int flag, const char *local, const char *origin, const char *remote);
48
e496c003 49#endif