Andrew's git - gitweb.git/blob

   1#ifndef BRANCH_H
   2#define BRANCH_H
   3
   4struct strbuf;
   5
   6/* Functions for acting on the information about branches. */
   7
   8/*
   9 * Creates a new branch, where:
  10 *
  11 *   - name is the new branch name
  12 *
  13 *   - start_name is the name of the existing branch that the new branch should
  14 *     start from
  15 *
  16 *   - force enables overwriting an existing (non-head) 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 *   - reflog creates a reflog for the branch
  22 *
  23 *   - quiet suppresses tracking information
  24 *
  25 *   - track causes the new branch to be configured to merge the remote branch
  26 *     that start_name is a tracking branch for (if any).
  27 *
  28 */
  29void create_branch(const char *name, const char *start_name,
  30                   int force, int clobber_head_ok,
  31                   int reflog, int quiet, enum branch_track track);
  32
  33/*
  34 * Check if 'name' can be a valid name for a branch; die otherwise.
  35 * Return 1 if the named branch already exists; return 0 otherwise.
  36 * Fill ref with the full refname for the branch.
  37 */
  38extern int validate_branchname(const char *name, struct strbuf *ref);
  39
  40/*
  41 * Check if a branch 'name' can be created as a new branch; die otherwise.
  42 * 'force' can be used when it is OK for the named branch already exists.
  43 * Return 1 if the named branch already exists; return 0 otherwise.
  44 * Fill ref with the full refname for the branch.
  45 */
  46extern int validate_new_branchname(const char *name, struct strbuf *ref, int force);
  47
  48/*
  49 * Remove information about the state of working on the current
  50 * branch. (E.g., MERGE_HEAD)
  51 */
  52void 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
  60extern int install_branch_config(int flag, const char *local, const char *origin, const char *remote);
  61
  62/*
  63 * Read branch description
  64 */
  65extern 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 */
  72extern 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 */
  79extern int replace_each_worktree_head_symref(const char *oldref, const char *newref,
  80                                             const char *logmsg);
  81
  82#endif