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