| Daniel Barkalow | e496c00 | 2008-02-07 16:40:08 | [diff] [blame] | 1 | #ifndef BRANCH_H |
| 2 | #define BRANCH_H |
| 3 | |
| Daniel Barkalow | c369e7b | 2008-02-07 16:40:16 | [diff] [blame] | 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 | */ |
| 15 | void create_branch(const char *head, const char *name, const char *start_name, |
| Jonathan Nieder | 39bd6f7 | 2011-11-26 08:54:55 | [diff] [blame] | 16 | int force, int reflog, |
| Jeff King | f9a482e | 2012-03-26 23:51:01 | [diff] [blame] | 17 | int clobber_head, int quiet, enum branch_track track); |
| Daniel Barkalow | e496c00 | 2008-02-07 16:40:08 | [diff] [blame] | 18 | |
| Daniel Barkalow | c369e7b | 2008-02-07 16:40:16 | [diff] [blame] | 19 | /* |
| Conrad Irwin | 55c4a67 | 2011-08-20 21:49:48 | [diff] [blame] | 20 | * Validates that the requested branch may be created, returning the |
| 21 | * interpreted ref in ref, force indicates whether (non-head) branches |
| 22 | * may be overwritten. A non-zero return value indicates that the force |
| 23 | * parameter was non-zero and the branch already exists. |
| Junio C Hamano | fa79937 | 2011-09-16 23:28:38 | [diff] [blame] | 24 | * |
| 25 | * Contrary to all of the above, when attr_only is 1, the caller is |
| 26 | * not interested in verifying if it is Ok to update the named |
| 27 | * branch to point at a potentially different commit. It is merely |
| 28 | * asking if it is OK to change some attribute for the named branch |
| 29 | * (e.g. tracking upstream). |
| 30 | * |
| 31 | * NEEDSWORK: This needs to be split into two separate functions in the |
| 32 | * longer run for sanity. |
| 33 | * |
| Conrad Irwin | 55c4a67 | 2011-08-20 21:49:48 | [diff] [blame] | 34 | */ |
| Junio C Hamano | fa79937 | 2011-09-16 23:28:38 | [diff] [blame] | 35 | int validate_new_branchname(const char *name, struct strbuf *ref, int force, int attr_only); |
| Conrad Irwin | 55c4a67 | 2011-08-20 21:49:48 | [diff] [blame] | 36 | |
| 37 | /* |
| Daniel Barkalow | c369e7b | 2008-02-07 16:40:16 | [diff] [blame] | 38 | * Remove information about the state of working on the current |
| 39 | * branch. (E.g., MERGE_HEAD) |
| 40 | */ |
| 41 | void remove_branch_state(void); |
| 42 | |
| Junio C Hamano | a9f2c13 | 2009-03-04 06:29:55 | [diff] [blame] | 43 | /* |
| Matthieu Moy | 1393123 | 2010-11-02 15:31:25 | [diff] [blame] | 44 | * Configure local branch "local" as downstream to branch "remote" |
| 45 | * from remote "origin". Used by git branch --set-upstream. |
| Patrick Steinhardt | 27852b2 | 2016-02-22 11:23:23 | [diff] [blame] | 46 | * Returns 0 on success. |
| Junio C Hamano | a9f2c13 | 2009-03-04 06:29:55 | [diff] [blame] | 47 | */ |
| 48 | #define BRANCH_CONFIG_VERBOSE 01 |
| Patrick Steinhardt | 27852b2 | 2016-02-22 11:23:23 | [diff] [blame] | 49 | extern int install_branch_config(int flag, const char *local, const char *origin, const char *remote); |
| Junio C Hamano | a9f2c13 | 2009-03-04 06:29:55 | [diff] [blame] | 50 | |
| Junio C Hamano | 6f9a332 | 2011-09-22 03:19:38 | [diff] [blame] | 51 | /* |
| 52 | * Read branch description |
| 53 | */ |
| 54 | extern int read_branch_desc(struct strbuf *, const char *branch_name); |
| 55 | |
| Eric Sunshine | ed89f84 | 2015-07-17 23:00:04 | [diff] [blame] | 56 | /* |
| 57 | * Check if a branch is checked out in the main worktree or any linked |
| 58 | * worktree and die (with a message describing its checkout location) if |
| 59 | * it is. |
| 60 | */ |
| Nguyễn Thái Ngọc Duy | 8d9fdd7 | 2016-04-22 13:01:33 | [diff] [blame] | 61 | extern void die_if_checked_out(const char *branch, int ignore_current_worktree); |
| Eric Sunshine | ed89f84 | 2015-07-17 23:00:04 | [diff] [blame] | 62 | |
| Kazuki Yamaguchi | 70999e9 | 2016-03-27 14:37:14 | [diff] [blame] | 63 | /* |
| 64 | * Update all per-worktree HEADs pointing at the old ref to point the new ref. |
| 65 | * This will be used when renaming a branch. Returns 0 if successful, non-zero |
| 66 | * otherwise. |
| 67 | */ |
| 68 | extern int replace_each_worktree_head_symref(const char *oldref, const char *newref); |
| 69 | |
| Daniel Barkalow | e496c00 | 2008-02-07 16:40:08 | [diff] [blame] | 70 | #endif |
