Merge branch 'ld/p4-update-shelve' into next
[git] / branch.h
1 #ifndef BRANCH_H
2 #define BRANCH_H
3
4 /* Functions for acting on the information about branches. */
5
6 /*
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  *
16  *   - reflog creates a reflog for the branch
17  *
18  *   - track causes the new branch to be configured to merge the remote branch
19  *     that start_name is a tracking branch for (if any).
20  */
21 void create_branch(const char *name, const char *start_name,
22                    int force, int reflog,
23                    int clobber_head, int quiet, enum branch_track track);
24
25 /*
26  * Validates that the requested branch may be created, returning the
27  * interpreted ref in ref, force indicates whether (non-head) branches
28  * may be overwritten. A non-zero return value indicates that the force
29  * parameter was non-zero and the branch already exists.
30  *
31  * Contrary to all of the above, when attr_only is 1, the caller is
32  * not interested in verifying if it is Ok to update the named
33  * branch to point at a potentially different commit. It is merely
34  * asking if it is OK to change some attribute for the named branch
35  * (e.g. tracking upstream).
36  *
37  * NEEDSWORK: This needs to be split into two separate functions in the
38  * longer run for sanity.
39  *
40  */
41 int validate_new_branchname(const char *name, struct strbuf *ref, int force, int attr_only);
42
43 /*
44  * Remove information about the state of working on the current
45  * branch. (E.g., MERGE_HEAD)
46  */
47 void remove_branch_state(void);
48
49 /*
50  * Configure local branch "local" as downstream to branch "remote"
51  * from remote "origin".  Used by git branch --set-upstream.
52  * Returns 0 on success.
53  */
54 #define BRANCH_CONFIG_VERBOSE 01
55 extern int install_branch_config(int flag, const char *local, const char *origin, const char *remote);
56
57 /*
58  * Read branch description
59  */
60 extern int read_branch_desc(struct strbuf *, const char *branch_name);
61
62 /*
63  * Check if a branch is checked out in the main worktree or any linked
64  * worktree and die (with a message describing its checkout location) if
65  * it is.
66  */
67 extern void die_if_checked_out(const char *branch, int ignore_current_worktree);
68
69 /*
70  * Update all per-worktree HEADs pointing at the old ref to point the new ref.
71  * This will be used when renaming a branch. Returns 0 if successful, non-zero
72  * otherwise.
73  */
74 extern int replace_each_worktree_head_symref(const char *oldref, const char *newref);
75
76 #endif