libgit2

git_branch_move

Version:

Move/rename an existing local branch reference.

The new branch name will be checked for validity. See git_tag_create() for rules about valid names.

Note that if the move succeeds, the old reference object will not be valid anymore, and should be freed immediately by the user using git_reference_free().

Signature

GitHub
int git_branch_move(git_reference **out, git_reference *branch, const char *new_branch_name, int force);

Parameters

git_reference **
In
out

New reference object for the updated name.

git_reference *
In
branch

Current underlying reference of the branch.

const char *
In
new_branch_name

Target name of the branch once the move is performed; this name is validated for consistency.

int
In
force

Overwrite existing branch.

Returns

int

0 on success, GIT_EINVALIDSPEC or an error code.

Versions