]>
Commit | Line | Data |
---|---|---|
1 | #ifndef BRANCH_H | |
2 | #define BRANCH_H | |
3 | ||
4 | struct repository; | |
5 | struct strbuf; | |
6 | ||
7 | enum branch_track { | |
8 | BRANCH_TRACK_UNSPECIFIED = -1, | |
9 | BRANCH_TRACK_NEVER = 0, | |
10 | BRANCH_TRACK_REMOTE, | |
11 | BRANCH_TRACK_ALWAYS, | |
12 | BRANCH_TRACK_EXPLICIT, | |
13 | BRANCH_TRACK_OVERRIDE | |
14 | }; | |
15 | ||
16 | extern enum branch_track git_branch_track; | |
17 | ||
18 | /* Functions for acting on the information about branches. */ | |
19 | ||
20 | /* | |
21 | * Creates a new branch, where: | |
22 | * | |
23 | * - r is the repository to add a branch to | |
24 | * | |
25 | * - name is the new branch name | |
26 | * | |
27 | * - start_name is the name of the existing branch that the new branch should | |
28 | * start from | |
29 | * | |
30 | * - force enables overwriting an existing (non-head) branch | |
31 | * | |
32 | * - clobber_head_ok allows the currently checked out (hence existing) | |
33 | * branch to be overwritten; without 'force', it has no effect. | |
34 | * | |
35 | * - reflog creates a reflog for the branch | |
36 | * | |
37 | * - quiet suppresses tracking information | |
38 | * | |
39 | * - track causes the new branch to be configured to merge the remote branch | |
40 | * that start_name is a tracking branch for (if any). | |
41 | * | |
42 | */ | |
43 | void create_branch(struct repository *r, | |
44 | const char *name, const char *start_name, | |
45 | int force, int clobber_head_ok, | |
46 | int reflog, int quiet, enum branch_track track); | |
47 | ||
48 | /* | |
49 | * Check if 'name' can be a valid name for a branch; die otherwise. | |
50 | * Return 1 if the named branch already exists; return 0 otherwise. | |
51 | * Fill ref with the full refname for the branch. | |
52 | */ | |
53 | int validate_branchname(const char *name, struct strbuf *ref); | |
54 | ||
55 | /* | |
56 | * Check if a branch 'name' can be created as a new branch; die otherwise. | |
57 | * 'force' can be used when it is OK for the named branch already exists. | |
58 | * Return 1 if the named branch already exists; return 0 otherwise. | |
59 | * Fill ref with the full refname for the branch. | |
60 | */ | |
61 | int validate_new_branchname(const char *name, struct strbuf *ref, int force); | |
62 | ||
63 | /* | |
64 | * Remove information about the merge state on the current | |
65 | * branch. (E.g., MERGE_HEAD) | |
66 | */ | |
67 | void remove_merge_branch_state(struct repository *r); | |
68 | ||
69 | /* | |
70 | * Remove information about the state of working on the current | |
71 | * branch. (E.g., MERGE_HEAD) | |
72 | */ | |
73 | void remove_branch_state(struct repository *r, int verbose); | |
74 | ||
75 | /* | |
76 | * Configure local branch "local" as downstream to branch "remote" | |
77 | * from remote "origin". Used by git branch --set-upstream. | |
78 | * Returns 0 on success. | |
79 | */ | |
80 | #define BRANCH_CONFIG_VERBOSE 01 | |
81 | int install_branch_config(int flag, const char *local, const char *origin, const char *remote); | |
82 | ||
83 | /* | |
84 | * Read branch description | |
85 | */ | |
86 | int read_branch_desc(struct strbuf *, const char *branch_name); | |
87 | ||
88 | /* | |
89 | * Check if a branch is checked out in the main worktree or any linked | |
90 | * worktree and die (with a message describing its checkout location) if | |
91 | * it is. | |
92 | */ | |
93 | void die_if_checked_out(const char *branch, int ignore_current_worktree); | |
94 | ||
95 | /* | |
96 | * Update all per-worktree HEADs pointing at the old ref to point the new ref. | |
97 | * This will be used when renaming a branch. Returns 0 if successful, non-zero | |
98 | * otherwise. | |
99 | */ | |
100 | int replace_each_worktree_head_symref(const char *oldref, const char *newref, | |
101 | const char *logmsg); | |
102 | ||
103 | #endif |