diff options
| author | nulltoken <emeric.fermas@gmail.com> | 2012-11-12 16:49:29 +0100 |
|---|---|---|
| committer | nulltoken <emeric.fermas@gmail.com> | 2012-12-01 08:34:27 +0100 |
| commit | 80212ecb1c2ce3e27d1a4ffe053e36260ee06c01 (patch) | |
| tree | f838a0c4d622c1ff4748d59e8c6c3710ea9475be /include/git2/reflog.h | |
| parent | e4aa7f58fefc7455b5527d410ad3f9c2c4032820 (diff) | |
| download | libgit2-80212ecb1c2ce3e27d1a4ffe053e36260ee06c01.tar.gz | |
reflog: Deploy EINVALIDSPEC usage
Diffstat (limited to 'include/git2/reflog.h')
| -rw-r--r-- | include/git2/reflog.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/git2/reflog.h b/include/git2/reflog.h index 45dff2165..418826d1d 100644 --- a/include/git2/reflog.h +++ b/include/git2/reflog.h @@ -63,9 +63,12 @@ GIT_EXTERN(int) git_reflog_append(git_reflog *reflog, const git_oid *id, const g * * The reflog to be renamed is expected to already exist * + * The new name will be checked for validity. + * See `git_reference_create_symbolic()` for rules about valid names. + * * @param ref the reference * @param name the new name of the reference - * @return 0 or an error code + * @return 0 on success, GIT_EINVALIDSPEC or an error code */ GIT_EXTERN(int) git_reflog_rename(git_reference *ref, const char *name); |