1 /* 2 * Copyright (C) the libgit2 contributors. All rights reserved. 3 * 4 * This file is part of libgit2, distributed under the GNU GPL v2 with 5 * a Linking Exception. For full terms see the included COPYING file. 6 */ 7 #ifndef INCLUDE_git_cherrypick_h__ 8 #define INCLUDE_git_cherrypick_h__ 9 10 #include "common.h" 11 #include "types.h" 12 #include "merge.h" 13 14 /** 15 * @file git2/cherrypick.h 16 * @brief Git cherry-pick routines 17 * @defgroup git_cherrypick Git cherry-pick routines 18 * @ingroup Git 19 * @{ 20 */ 21 GIT_BEGIN_DECL 22 23 /** 24 * Cherry-pick options 25 */ 26 typedef struct { 27 unsigned int version; 28 29 /** For merge commits, the "mainline" is treated as the parent. */ 30 unsigned int mainline; 31 32 git_merge_options merge_opts; /**< Options for the merging */ 33 git_checkout_options checkout_opts; /**< Options for the checkout */ 34 } git_cherrypick_options; 35 36 #define GIT_CHERRYPICK_OPTIONS_VERSION 1 37 #define GIT_CHERRYPICK_OPTIONS_INIT {GIT_CHERRYPICK_OPTIONS_VERSION, 0, GIT_MERGE_OPTIONS_INIT, GIT_CHECKOUT_OPTIONS_INIT} 38 39 /** 40 * Initializes a `git_cherrypick_options` with default values. Equivalent to 41 * creating an instance with GIT_CHERRYPICK_OPTIONS_INIT. 42 * 43 * @param opts the `git_cherrypick_options` struct to initialize 44 * @param version Version of struct; pass `GIT_CHERRYPICK_OPTIONS_VERSION` 45 * @return Zero on success; -1 on failure. 46 */ 47 GIT_EXTERN(int) git_cherrypick_init_options( 48 git_cherrypick_options *opts, 49 unsigned int version); 50 51 /** 52 * Cherry-picks the given commit against the given "our" commit, producing an 53 * index that reflects the result of the cherry-pick. 54 * 55 * The returned index must be freed explicitly with `git_index_free`. 56 * 57 * @param out pointer to store the index result in 58 * @param repo the repository that contains the given commits 59 * @param cherrypick_commit the commit to cherry-pick 60 * @param our_commit the commit to revert against (eg, HEAD) 61 * @param mainline the parent of the revert commit, if it is a merge 62 * @param merge_options the merge options (or null for defaults) 63 * @return zero on success, -1 on failure. 64 */ 65 GIT_EXTERN(int) git_cherrypick_commit( 66 git_index **out, 67 git_repository *repo, 68 git_commit *cherrypick_commit, 69 git_commit *our_commit, 70 unsigned int mainline, 71 const git_merge_options *merge_options); 72 73 /** 74 * Cherry-pick the given commit, producing changes in the index and working directory. 75 * 76 * @param repo the repository to cherry-pick 77 * @param commit the commit to cherry-pick 78 * @param cherrypick_options the cherry-pick options (or null for defaults) 79 * @return zero on success, -1 on failure. 80 */ 81 GIT_EXTERN(int) git_cherrypick( 82 git_repository *repo, 83 git_commit *commit, 84 const git_cherrypick_options *cherrypick_options); 85 86 /** @} */ 87 GIT_END_DECL 88 89 #endif 90 91