thodg/libgit2/include/git2/annotated_commit.h

• Show log

  Commit

• Hash : 62dd4d71
  Author :
  Date : 2015-03-07T00:06:02
  

  annotated_commit: provide a constructor from a revspec This extra constructor will be useful for the annotated versions of ref-modifying functions, as it allows us to create a commit with the extended sha syntax which was used to retrieve it.

Download

• include/git2/annotated_commit.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef INCLUDE_git_annotated_commit_h__
  #define INCLUDE_git_annotated_commit_h__
  
  #include "common.h"
  #include "repository.h"
  #include "types.h"
  
  /**
   * @file git2/annotated_commit.h
   * @brief Git annotated commit routines
   * @defgroup git_annotated_commit Git annotated commit routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Creates a `git_annotated_commit` from the given reference.
   * The resulting git_annotated_commit must be freed with
   * `git_annotated_commit_free`.
   *
   * @param out pointer to store the git_annotated_commit result in
   * @param repo repository that contains the given reference
   * @param ref reference to use to lookup the git_annotated_commit
   * @return 0 on success or error code
   */
  GIT_EXTERN(int) git_annotated_commit_from_ref(
  	git_annotated_commit **out,
  	git_repository *repo,
  	const git_reference *ref);
  
  /**
   * Creates a `git_annotated_commit` from the given fetch head data.
   * The resulting git_annotated_commit must be freed with
   * `git_annotated_commit_free`.
   *
   * @param out pointer to store the git_annotated_commit result in
   * @param repo repository that contains the given commit
   * @param branch_name name of the (remote) branch
   * @param remote_url url of the remote
   * @param id the commit object id of the remote branch
   * @return 0 on success or error code
   */
  GIT_EXTERN(int) git_annotated_commit_from_fetchhead(
  	git_annotated_commit **out,
  	git_repository *repo,
  	const char *branch_name,
  	const char *remote_url,
  	const git_oid *id);
  
  /**
   * Creates a `git_annotated_commit` from the given commit id.
   * The resulting git_annotated_commit must be freed with
   * `git_annotated_commit_free`.
   *
   * An annotated commit contains information about how it was
   * looked up, which may be useful for functions like merge or
   * rebase to provide context to the operation.  For example,
   * conflict files will include the name of the source or target
   * branches being merged.  It is therefore preferable to use the
   * most specific function (eg `git_annotated_commit_from_ref`)
   * instead of this one when that data is known.
   *
   * @param out pointer to store the git_annotated_commit result in
   * @param repo repository that contains the given commit
   * @param id the commit object id to lookup
   * @return 0 on success or error code
   */
  GIT_EXTERN(int) git_annotated_commit_lookup(
  	git_annotated_commit **out,
  	git_repository *repo,
  	const git_oid *id);
  
  /**
   * Creates a `git_annotated_comit` from a revision string.
   *
   * See `man gitrevisions`, or
   * http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for
   * information on the syntax accepted.
   *
   * @param out pointer to store the git_annotated_commit result in
   * @param repo repository that contains the given commit
   * @param revspec the extended sha syntax string to use to lookup the commit
   * @return 0 on success or error code
   */
  GIT_EXTERN(int) git_annotated_commit_from_revspec(
  	git_annotated_commit **out,
  	git_repository *repo,
  	const char *revspec);
  
  /**
   * Gets the commit ID that the given `git_annotated_commit` refers to.
   *
   * @param commit the given annotated commit
   * @return commit id
   */
  GIT_EXTERN(const git_oid *) git_annotated_commit_id(
  	const git_annotated_commit *commit);
  
  /**
   * Frees a `git_annotated_commit`.
   *
   * @param commit annotated commit to free
   */
  GIT_EXTERN(void) git_annotated_commit_free(
  	git_annotated_commit *commit);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download