commit.h 1.07 KB
Newer Older
1 2 3
#ifndef INCLUDE_git_commit_h__
#define INCLUDE_git_commit_h__

4 5
#include "common.h"
#include "oid.h"
6 7

/**
8
 * @file git/commit.h
9 10 11 12 13 14 15 16
 * @brief Git commit parsing, formatting routines
 * @defgroup git_commit Git commit parsing, formatting routines
 * @ingroup Git
 * @{
 */
GIT_BEGIN_DECL

/** Parsed representation of a commit object. */
17
typedef struct git_commit git_commit;
18 19 20 21 22 23 24

/**
 * Parse (or lookup) a commit from a revision pool.
 * @param pool the pool to use when parsing/caching the commit.
 * @param id identity of the commit to locate.  If the object is
 *        an annotated tag it will be peeled back to the commit.
 * @return the commit; NULL if the commit does not exist in the
25
 *         pool's git_odb, or if the commit is present but is
26 27
 *         too malformed to be parsed successfully.
 */
28
GIT_EXTERN(git_commit*) git_commit_parse(git_revpool *pool, const git_oid *id);
29 30 31 32 33 34

/**
 * Get the id of a commit.
 * @param commit a previously parsed commit.
 * @return object identity for the commit.
 */
35
GIT_EXTERN(const git_oid*) git_commit_id(git_commit *commit);
36 37 38 39

/** @} */
GIT_END_DECL
#endif