Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up of merge! documentation #22503

Merged
merged 1 commit into from
Jun 25, 2017
Merged

clean up of merge! documentation #22503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions base/libgit2/merge.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ function merge_analysis(repo::GitRepo, anns::Vector{GitAnnotated})
return analysis[], preference[]
end

"""Fastforward merge changes into current head """
"""
ffmerge!(repo::GitRepo, ann::GitAnnotated)

Fastforward merge changes into current head
"""
function ffmerge!(repo::GitRepo, ann::GitAnnotated)
cmt = GitCommit(repo, GitHash(ann))

Expand All @@ -63,7 +67,7 @@ function ffmerge!(repo::GitRepo, ann::GitAnnotated)
return true
end

""" Merge changes into current head """
# Merge changes into current head
function merge!(repo::GitRepo, anns::Vector{GitAnnotated};
merge_opts::MergeOptions = MergeOptions(),
checkout_opts::CheckoutOptions = CheckoutOptions())
Expand All @@ -77,9 +81,8 @@ function merge!(repo::GitRepo, anns::Vector{GitAnnotated};
return true
end

"""Internal implementation of merge.
Returns `true` if merge was successful, otherwise `false`
"""
# Internal implementation of merge.
# Returns `true` if merge was successful, otherwise `false`
function merge!(repo::GitRepo, anns::Vector{GitAnnotated}, fastforward::Bool;
merge_opts::MergeOptions = MergeOptions(),
checkout_opts::CheckoutOptions = CheckoutOptions())
Expand Down
1 change: 1 addition & 0 deletions doc/src/devdocs/libgit2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Base.LibGit2.diff_files
Base.LibGit2.fetch
Base.LibGit2.fetch_refspecs
Base.LibGit2.fetchhead_foreach_cb
Base.LibGit2.merge!(::Base.LibGit2.GitRepo; ::Any...)
Base.LibGit2.ffmerge!
Base.LibGit2.fullname
Base.LibGit2.get_creds!
Expand Down
3 changes: 2 additions & 1 deletion doc/src/stdlib/collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,8 @@ Base.pop!(::Any, ::Any, ::Any)
Base.keys
Base.values
Base.merge
Base.merge!
Base.merge!(::Associative, ::Associative...)
Base.merge!(::Function, ::Associative, ::Associative...)
Base.sizehint!
Base.keytype
Base.valtype
Expand Down