mirror of
https://github.com/git/git.git
synced 2024-11-01 06:47:52 +01:00
0faff988ee
Code clean-up. * ks/branch-cleanup: builtin/branch: strip refs/heads/ using skip_prefix branch: update warning message shown when copying a misnamed branch branch: group related arguments of create_branch() branch: improve documentation and naming of create_branch() parameters
80 lines
2.5 KiB
C
80 lines
2.5 KiB
C
#ifndef BRANCH_H
|
|
#define BRANCH_H
|
|
|
|
/* Functions for acting on the information about branches. */
|
|
|
|
/*
|
|
* Creates a new branch, where:
|
|
*
|
|
* - name is the new branch name
|
|
*
|
|
* - start_name is the name of the existing branch that the new branch should
|
|
* start from
|
|
*
|
|
* - force enables overwriting an existing (non-head) branch
|
|
*
|
|
* - clobber_head_ok allows the currently checked out (hence existing)
|
|
* branch to be overwritten; without 'force', it has no effect.
|
|
*
|
|
* - reflog creates a reflog for the branch
|
|
*
|
|
* - quiet suppresses tracking information
|
|
*
|
|
* - track causes the new branch to be configured to merge the remote branch
|
|
* that start_name is a tracking branch for (if any).
|
|
*
|
|
*/
|
|
void create_branch(const char *name, const char *start_name,
|
|
int force, int clobber_head_ok,
|
|
int reflog, int quiet, enum branch_track track);
|
|
|
|
/*
|
|
* Check if 'name' can be a valid name for a branch; die otherwise.
|
|
* Return 1 if the named branch already exists; return 0 otherwise.
|
|
* Fill ref with the full refname for the branch.
|
|
*/
|
|
extern int validate_branchname(const char *name, struct strbuf *ref);
|
|
|
|
/*
|
|
* Check if a branch 'name' can be created as a new branch; die otherwise.
|
|
* 'force' can be used when it is OK for the named branch already exists.
|
|
* Return 1 if the named branch already exists; return 0 otherwise.
|
|
* Fill ref with the full refname for the branch.
|
|
*/
|
|
extern int validate_new_branchname(const char *name, struct strbuf *ref, int force);
|
|
|
|
/*
|
|
* Remove information about the state of working on the current
|
|
* branch. (E.g., MERGE_HEAD)
|
|
*/
|
|
void remove_branch_state(void);
|
|
|
|
/*
|
|
* Configure local branch "local" as downstream to branch "remote"
|
|
* from remote "origin". Used by git branch --set-upstream.
|
|
* Returns 0 on success.
|
|
*/
|
|
#define BRANCH_CONFIG_VERBOSE 01
|
|
extern int install_branch_config(int flag, const char *local, const char *origin, const char *remote);
|
|
|
|
/*
|
|
* Read branch description
|
|
*/
|
|
extern int read_branch_desc(struct strbuf *, const char *branch_name);
|
|
|
|
/*
|
|
* Check if a branch is checked out in the main worktree or any linked
|
|
* worktree and die (with a message describing its checkout location) if
|
|
* it is.
|
|
*/
|
|
extern void die_if_checked_out(const char *branch, int ignore_current_worktree);
|
|
|
|
/*
|
|
* Update all per-worktree HEADs pointing at the old ref to point the new ref.
|
|
* This will be used when renaming a branch. Returns 0 if successful, non-zero
|
|
* otherwise.
|
|
*/
|
|
extern int replace_each_worktree_head_symref(const char *oldref, const char *newref,
|
|
const char *logmsg);
|
|
|
|
#endif
|