| 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 | /* |
| Jeff King | 4bd488e | 2016-11-04 16:30:12 | [diff] [blame] | 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). |
| Daniel Barkalow | c369e7b | 2008-02-07 16:40:16 | [diff] [blame] | 20 | */ |
| Jeff King | 4bd488e | 2016-11-04 16:30:12 | [diff] [blame] | 21 | void create_branch(const char *name, const char *start_name, |
| Jonathan Nieder | 39bd6f7 | 2011-11-26 08:54:55 | [diff] [blame] | 22 | int force, int reflog, |
| Jeff King | f9a482e | 2012-03-26 23:51:01 | [diff] [blame] | 23 | int clobber_head, int quiet, enum branch_track track); |
| Daniel Barkalow | e496c00 | 2008-02-07 16:40:08 | [diff] [blame] | 24 | |
| Daniel Barkalow | c369e7b | 2008-02-07 16:40:16 | [diff] [blame] | 25 | /* |
| Conrad Irwin | 55c4a67 | 2011-08-20 21:49:48 | [diff] [blame] | 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. |
| Junio C Hamano | fa79937 | 2011-09-16 23:28:38 | [diff] [blame] | 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 | * |
| Conrad Irwin | 55c4a67 | 2011-08-20 21:49:48 | [diff] [blame] | 40 | */ |
| Junio C Hamano | fa79937 | 2011-09-16 23:28:38 | [diff] [blame] | 41 | 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] | 42 | |
| 43 | /* |
| Daniel Barkalow | c369e7b | 2008-02-07 16:40:16 | [diff] [blame] | 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 | |
| Junio C Hamano | a9f2c13 | 2009-03-04 06:29:55 | [diff] [blame] | 49 | /* |
| Matthieu Moy | 1393123 | 2010-11-02 15:31:25 | [diff] [blame] | 50 | * Configure local branch "local" as downstream to branch "remote" |
| 51 | * from remote "origin". Used by git branch --set-upstream. |
| Patrick Steinhardt | 27852b2 | 2016-02-22 11:23:23 | [diff] [blame] | 52 | * Returns 0 on success. |
| Junio C Hamano | a9f2c13 | 2009-03-04 06:29:55 | [diff] [blame] | 53 | */ |
| 54 | #define BRANCH_CONFIG_VERBOSE 01 |
| Patrick Steinhardt | 27852b2 | 2016-02-22 11:23:23 | [diff] [blame] | 55 | 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] | 56 | |
| Junio C Hamano | 6f9a332 | 2011-09-22 03:19:38 | [diff] [blame] | 57 | /* |
| 58 | * Read branch description |
| 59 | */ |
| 60 | extern int read_branch_desc(struct strbuf *, const char *branch_name); |
| 61 | |
| Eric Sunshine | ed89f84 | 2015-07-17 23:00:04 | [diff] [blame] | 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 | */ |
| Nguyễn Thái Ngọc Duy | 8d9fdd7 | 2016-04-22 13:01:33 | [diff] [blame] | 67 | extern void die_if_checked_out(const char *branch, int ignore_current_worktree); |
| Eric Sunshine | ed89f84 | 2015-07-17 23:00:04 | [diff] [blame] | 68 | |
| Kazuki Yamaguchi | 70999e9 | 2016-03-27 14:37:14 | [diff] [blame] | 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 | */ |
| Kyle Meyer | 39ee4c6 | 2017-02-21 01:10:35 | [diff] [blame] | 74 | extern int replace_each_worktree_head_symref(const char *oldref, const char *newref, |
| 75 | const char *logmsg); |
| Kazuki Yamaguchi | 70999e9 | 2016-03-27 14:37:14 | [diff] [blame] | 76 | |
| Daniel Barkalow | e496c00 | 2008-02-07 16:40:08 | [diff] [blame] | 77 | #endif |
