thodg/libgit2/src/git/commit.h

• Show log

  Commit

• Hash : 58519018
  Author :
  Date : 2010-10-28T02:07:18
  

  Fix internal memory management on the library String mememory is now managed in a much more sane manner. Fixes include: - git_person email and name is no longer limited to 64 characters - git_tree_entry filename is no longer limited to 255 characters - raw objects are properly opened & closed the minimum amount of times required for parsing - unit tests no longer leak - removed 5 other misc memory leaks as reported by Valgrind - tree writeback no longer segfaults on rare ocassions The git_person struct is no longer public. It is now managed by the library, and getter methods are in place to access its internal attributes. 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);
  
  /**
   * Create a new in-memory git_commit.
   *
   * The commit object must be manually filled using
   * setter methods before it can be written to its
   * repository.
   *
   * @param repo The repository where the object will reside
   * @return the object if creation was possible; NULL otherwise
   */
  GIT_EXTERN(git_commit *) git_commit_new(git_repository *repo);
  
  /**
   * 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);
  
  /**
   * Add a new parent commit to an existing commit
   * @param commit the commit object
   * @param new_parent the new commit which will be a parent
   */
  GIT_EXTERN(void) git_commit_add_parent(git_commit *commit, git_commit *new_parent);
  
  /**
   * Set the message of a commit
   * @param commit the commit object
   * @param message the new message
   */
  GIT_EXTERN(void) git_commit_set_message(git_commit *commit, const char *message);
  
  /**
   * Set the committer of a commit
   * @param commit the commit object
   * @param name name of the new committer
   * @param email email of the new committer
   * @param time time when the committer committed the commit
   */
  GIT_EXTERN(void) git_commit_set_committer(git_commit *commit, const char *name, const char *email, time_t time);
  
  /**
   * Set the author of a commit
   * @param commit the commit object
   * @param name name of the new author
   * @param email email of the new author
   * @param time time when the author created the commit
   */
  GIT_EXTERN(void) git_commit_set_author(git_commit *commit, const char *name, const char *email, time_t time);
  
  /**
   * Set the tree which is pointed to by a commit
   * @param commit the commit object
   * @param tree the new tree
   */
  GIT_EXTERN(void) git_commit_set_tree(git_commit *commit, git_tree *tree);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download