libgit2

git_reference_rename

Version:

Rename an existing reference.

This method works for both direct and symbolic references.

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

If the force flag is not enabled, and there's already a reference with the given name, the renaming will fail.

IMPORTANT: The user needs to write a proper reflog entry if the reflog is enabled for the repository. We only rename the reflog if it exists.

Signature

GitHub
int git_reference_rename(git_reference **new_ref, git_reference *ref, const char *new_name, int force, const char *log_message);

Parameters

git_reference **
In
new_ref
git_reference *
In
ref

The reference to rename

const char *
In
new_name

The new name for the reference

int
In
force

Overwrite an existing reference

const char *
In
log_message

The one line long message to be appended to the reflog

Returns

int

0 on success, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code

Versions