mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-03 04:01:41 +00:00
e7be57a98b
Rather than returning the OIDs out of the reflog as string return them as git_oid. Signed-off-by: schu <schu-github@schulog.org>
130 lines
3.6 KiB
C
130 lines
3.6 KiB
C
/*
|
|
* This file is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License, version 2,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* In addition to the permissions in the GNU General Public License,
|
|
* the authors give you unlimited permission to link the compiled
|
|
* version of this file into combinations with other programs,
|
|
* and to distribute those combinations without any restriction
|
|
* coming from the use of this file. (The General Public License
|
|
* restrictions do apply in other respects; for example, they cover
|
|
* modification of the file, and distribution when not linked into
|
|
* a combined executable.)
|
|
*
|
|
* This file is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; see the file COPYING. If not, write to
|
|
* the Free Software Foundation, 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
#ifndef INCLUDE_git_reflog_h__
|
|
#define INCLUDE_git_reflog_h__
|
|
|
|
#include "common.h"
|
|
#include "types.h"
|
|
#include "oid.h"
|
|
|
|
/**
|
|
* @file git2/reflog.h
|
|
* @brief Git reflog management routines
|
|
* @defgroup git_reflog Git reflog management routines
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
/**
|
|
* Read the reflog for the given reference
|
|
*
|
|
* The reflog must be freed manually by using
|
|
* git_reflog_free().
|
|
*
|
|
* @param reflog pointer to reflog
|
|
* @param ref reference to read the reflog for
|
|
* @return GIT_SUCCESS on success; error code otherwise
|
|
*/
|
|
GIT_EXTERN(int) git_reflog_read(git_reflog **reflog, git_reference *ref);
|
|
|
|
/**
|
|
* Write a new reflog for the given reference
|
|
*
|
|
* If there is no reflog file for the given
|
|
* reference yet, it will be created.
|
|
*
|
|
* `oid_old` may be NULL in case it's a new reference.
|
|
*
|
|
* `msg` is optional and can be NULL.
|
|
*
|
|
* @param ref the changed reference
|
|
* @param oid_old the OID the reference was pointing to
|
|
* @param committer the signature of the committer
|
|
* @param msg the reflog message
|
|
* @return GIT_SUCCESS on success; error code otherwise
|
|
*/
|
|
GIT_EXTERN(int) git_reflog_write(git_reference *ref, const git_oid *oid_old, const git_signature *committer, const char *msg);
|
|
|
|
/**
|
|
* Get the number of log entries in a reflog
|
|
*
|
|
* @param reflog the previously loaded reflog
|
|
* @return the number of log entries
|
|
*/
|
|
GIT_EXTERN(unsigned int) git_reflog_entrycount(git_reflog *reflog);
|
|
|
|
/**
|
|
* Lookup an entry by its index
|
|
*
|
|
* @param reflog a previously loaded reflog
|
|
* @param idx the position to lookup
|
|
* @return the entry; NULL if not found
|
|
*/
|
|
GIT_EXTERN(const git_reflog_entry *) git_reflog_entry_byindex(git_reflog *reflog, unsigned int idx);
|
|
|
|
/**
|
|
* Get the old oid
|
|
*
|
|
* @param entry a reflog entry
|
|
* @return the old oid
|
|
*/
|
|
GIT_EXTERN(const git_oid *) git_reflog_entry_oidold(const git_reflog_entry *entry);
|
|
|
|
/**
|
|
* Get the new oid
|
|
*
|
|
* @param entry a reflog entry
|
|
* @return the new oid at this time
|
|
*/
|
|
GIT_EXTERN(const git_oid *) git_reflog_entry_oidnew(const git_reflog_entry *entry);
|
|
|
|
/**
|
|
* Get the committer of this entry
|
|
*
|
|
* @param entry a reflog entry
|
|
* @return the committer
|
|
*/
|
|
GIT_EXTERN(git_signature *) git_reflog_entry_committer(const git_reflog_entry *entry);
|
|
|
|
/**
|
|
* Get the log msg
|
|
*
|
|
* @param entry a reflog entry
|
|
* @return the log msg
|
|
*/
|
|
GIT_EXTERN(char *) git_reflog_entry_msg(const git_reflog_entry *entry);
|
|
|
|
/**
|
|
* Free the reflog
|
|
*
|
|
* @param reflog reflog to free
|
|
*/
|
|
GIT_EXTERN(void) git_reflog_free(git_reflog *reflog);
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
#endif
|