thodg/libgit2/src/git/commit.h

• Show log

  Commit

• Hash : 3315782c
  Author :
  Date : 2010-08-08T14:12:17
  

  Redesigned the walking/object lookup interface The old 'git_revpool' object has been removed and split into two distinct objects with separate functionality, in order to have separate methods for object management and object walking. * A new object 'git_repository' does the high-level management of a repository's objects (commits, trees, tags, etc) on top of a 'git_odb'. Eventually, it will also manage other repository attributes (e.g. tag resolution, references, etc). See: src/git/repository.h * A new external method 'git_repository_lookup(repo, oid, type)' has been added to the 'git_repository' API. All object lookups (git_XXX_lookup()) are now wrappers to this method, and duplicated code has been removed. The method does automatic type checking and returns a generic 'git_revpool_object' that can be cast to any specific object. See: src/git/repository.h * The external methods for object parsing of repository objects (git_XXX_parse()) have been removed. Loading objects from the repository is now managed through the 'lookup' functions. These objects are loaded with minimal information, and the relevant parsing is done automatically when the user requests any of the parsed attributes through accessor methods. An attribute has been added to 'git_repository' in order to force the parsing of all the repository objects immediately after lookup. See: src/git/commit.h See: src/git/tag.h See: src/git/tree.h * The previous walking functionality of the revpool is now found in 'git_revwalk', which does the actual revision walking on a repository; the attributes when walking through commits in a database have been decoupled from the actual commit objects. This increases performance when accessing commits during the walk and allows to have several 'git_revwalk' instances working at the same time on top of the same repository, without having to load commits in memory several times. See: src/git/revwalk.h * The old 'git_revpool_table' has been renamed to 'git_hashtable' and now works as a generic hashtable with support for any kind of object and custom hash functions. See: src/hashtable.h * All the relevant unit tests have been updated, renamed and grouped accordingly. Signed-off-by: Vicent Marti <tanoku@gmail.com>

Download

• src/git/commit.h

• #ifndef INCLUDE_git_commit_h__
  #define INCLUDE_git_commit_h__
  
  #include "common.h"
  #include "oid.h"
  #include "tree.h"
  #include "repository.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;
  
  /**
   * Lookup a commit object from a repository.
   * The generated commit object is owned by the revision
   * repo and shall not be freed by the user.
   *
   * @param repo the repo to use when locating 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 could not be created
   */
  GIT_EXTERN(git_commit *) git_commit_lookup(git_repository *repo, const git_oid *id);
  
  /**
   * Get the id of a commit.
   * @param commit a previously loaded commit.
   * @return object identity for the commit.
   */
  GIT_EXTERN(const git_oid *) git_commit_id(git_commit *commit);
  
  /**
   * Get the short (one line) message of a commit.
   * @param commit a previously loaded commit.
   * @return the short message of a commit
   */
  GIT_EXTERN(const char *) git_commit_message_short(git_commit *commit);
  
  /**
   * Get the full message of a commit.
   * @param commit a previously loaded commit.
   * @return the message of a commit
   */
  GIT_EXTERN(const char *) git_commit_message(git_commit *commit);
  
  /**
   * Get the commit time (i.e. committer time) of a commit.
   * @param commit a previously loaded commit.
   * @return the time of a commit
   */
  GIT_EXTERN(time_t) git_commit_time(git_commit *commit);
  
  /**
   * Get the committer of a commit.
   * @param commit a previously loaded commit.
   * @return the committer of a commit
   */
  GIT_EXTERN(const git_person *) git_commit_committer(git_commit *commit);
  
  /**
   * Get the author of a commit.
   * @param commit a previously loaded commit.
   * @return the author of a commit
   */
  GIT_EXTERN(const git_person *) git_commit_author(git_commit *commit);
  
  /**
   * Get the tree pointed to by a commit.
   * @param commit a previously loaded commit.
   * @return the tree of a commit
   */
  GIT_EXTERN(const git_tree *) git_commit_tree(git_commit *commit);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download