diff options
| author | Shawn O. Pearce <spearce@spearce.org> | 2008-11-01 15:42:23 -0700 |
|---|---|---|
| committer | Shawn O. Pearce <spearce@spearce.org> | 2008-11-01 15:42:23 -0700 |
| commit | d1ea30c399629de48ac3fe68869a21171ad131eb (patch) | |
| tree | 31438e245492d85fd6da4d1406eba0fbde8332a4 /include/git/commit.h | |
| parent | 3e89665eb6d5ab75051dc59fc8b63316908b19d1 (diff) | |
| download | libgit2-d1ea30c399629de48ac3fe68869a21171ad131eb.tar.gz | |
Move include files to include/git/, drop git_ prefix from file names
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Diffstat (limited to 'include/git/commit.h')
| -rw-r--r-- | include/git/commit.h | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/include/git/commit.h b/include/git/commit.h new file mode 100644 index 000000000..dbafe4e0c --- /dev/null +++ b/include/git/commit.h @@ -0,0 +1,83 @@ +/* + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Git Development Community nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef INCLUDE_git_commit_h__ +#define INCLUDE_git_commit_h__ + +#include "git/common.h" +#include "git/oid.h" +#include <time.h> + +/** + * @file git/commit.h + * @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. */ +typedef struct git_commit git_commit; +#ifdef GIT__PRIVATE +struct git_commit { + git_oid id; + time_t commit_time; + unsigned parsed:1, + flags:26; +}; +#endif + +/** + * 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 + * pool's git_odb, or if the commit is present but is + * too malformed to be parsed successfully. + */ +GIT_EXTERN(git_commit*) git_commit_parse(git_revp *pool, const git_oid *id); + +/** + * Get the id of a commit. + * @param commit a previously parsed commit. + * @return object identity for the commit. + */ +GIT_EXTERN(const git_oid*) git_commit_id(git_commit *commit); + +/** @} */ +GIT_END_DECL +#endif |
