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