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 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,
  16                    int force, int reflog, enum branch_track track);
  17
  18 /*
  19  * Validates that the requested branch may be created, returning the
  20  * interpreted ref in ref, force indicates whether (non-head) branches
  21  * may be overwritten. A non-zero return value indicates that the force
  22  * parameter was non-zero and the branch already exists.
  23  *
  24  * Contrary to all of the above, when attr_only is 1, the caller is
  25  * not interested in verifying if it is Ok to update the named
  26  * branch to point at a potentially different commit. It is merely
  27  * asking if it is OK to change some attribute for the named branch
  28  * (e.g. tracking upstream).
  29  *
  30  * NEEDSWORK: This needs to be split into two separate functions in the
  31  * longer run for sanity.
  32  *
  33  */
  34 int validate_new_branchname(const char *name, struct strbuf *ref, int force, int attr_only);
  35
  36 /*
  37  * Remove information about the state of working on the current
  38  * branch. (E.g., MERGE_HEAD)
  39  */
  40 void remove_branch_state(void);
  41
  42 /*
  43  * Configure local branch "local" as downstream to branch "remote"
  44  * from remote "origin".  Used by git branch --set-upstream.
  45  */
  46 #define BRANCH_CONFIG_VERBOSE 01
  47 extern void install_branch_config(int flag, const char *local, const char *origin, const char *remote);
  48
  49 /*
  50  * Read branch description
  51  */
  52 extern int read_branch_desc(struct strbuf *, const char *branch_name);
  53
  54 #endif