Skip to content

Commit 5e8eecd

Browse files
committed
Add more information for CherrypickOptions
1 parent 8809617 commit 5e8eecd

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

base/libgit2/types.jl

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -527,6 +527,15 @@ end
527527
LibGit2.CherrypickOptions
528528
529529
Matches the [`git_cherrypick_options`](https://libgit2.github.com/libgit2/#HEAD/type/git_cherrypick_options) struct.
530+
531+
The fields represent:
532+
* `version`: version of the struct in use, in case this changes later. For now, always `1`.
533+
* `mainline`: if cherrypicking a merge commit, specifies the parent number (starting at `1`)
534+
which will allow cherrypick to apply the changes relative to that parent. Only relevant if
535+
cherrypicking a merge commit. Default is `0`.
536+
* `merge_opts`: options for merging the changes in. See [`MergeOptions`](@ref) for more information.
537+
* `checkout_opts`: options for the checkout of the commit being cherrypicked. See [`CheckoutOptions`](@ref)
538+
for more information.
530539
"""
531540
@kwdef struct CherrypickOptions
532541
version::Cuint = 1

0 commit comments

Comments
 (0)