thodg/libgit2/include/git2/revert.h

• Show log

  Commit

• Hash : b9f81997
  Author :
  Date : 2014-03-05T21:49:23
  

  Added function-based initializers for every options struct. The basic structure of each function is courtesy of arrbee.

Download

• include/git2/revert.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_revert_h__
  #define INCLUDE_git_revert_h__
  
  #include "common.h"
  #include "types.h"
  #include "merge.h"
  
  /**
   * @file git2/revert.h
   * @brief Git revert routines
   * @defgroup git_revert Git revert routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  typedef struct {
  	unsigned int version;
  
  	/** For merge commits, the "mainline" is treated as the parent. */
  	unsigned int mainline;
  
  	git_merge_tree_opts merge_tree_opts;
  	git_checkout_opts checkout_opts;
  } git_revert_opts;
  
  #define GIT_REVERT_OPTS_VERSION 1
  #define GIT_REVERT_OPTS_INIT {GIT_REVERT_OPTS_VERSION, 0, GIT_MERGE_TREE_OPTS_INIT, GIT_CHECKOUT_OPTS_INIT}
  
  /**
   * Initializes a `git_revert_opts` with default values. Equivalent to
   * creating an instance with GIT_REVERT_OPTS_INIT.
   *
   * @param opts the `git_revert_opts` instance to initialize.
   * @param version the version of the struct; you should pass
   *        `GIT_REVERT_OPTS_VERSION` here.
   * @return Zero on success; -1 on failure.
   */
  GIT_EXTERN(int) git_revert_init_opts(
  	git_revert_opts* opts,
  	int version);
  
  /**
   * Reverts the given commit against the given "our" commit, producing an
   * index that reflects the result of the revert.
   *
   * The returned index must be freed explicitly with `git_index_free`.
   *
   * @param out pointer to store the index result in
   * @param repo the repository that contains the given commits
   * @param revert_commit the commit to revert
   * @param our_commit the commit to revert against (eg, HEAD)
   * @param mainline the parent of the revert commit, if it is a merge
   * @param merge_tree_opts the merge tree options (or null for defaults)
   * @return zero on success, -1 on failure.
   */
  int git_revert_commit(
  	git_index **out,
  	git_repository *repo,
  	git_commit *revert_commit,
  	git_commit *our_commit,
  	unsigned int mainline,
  	const git_merge_tree_opts *merge_tree_opts);
  
  /**
   * Reverts the given commit, producing changes in the working directory.
   *
   * @param repo the repository to revert
   * @param commits the commits to revert
   * @param commits_len the number of commits to revert
   * @param flags merge flags
   * @return zero on success, -1 on failure.
   */
  GIT_EXTERN(int) git_revert(
  	git_repository *repo,
  	git_commit *commit,
  	const git_revert_opts *given_opts);
  
  /** @} */
  GIT_END_DECL
  #endif
  
  

Download