Merge pull request #21721 from JuliaLang/ksh/cloneex

Add examples for clone
JuliaLang · May 6, 2017 · 45b2c33 · 45b2c33
2 parents 85c53be + c4ed32e
commit 45b2c33
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/base/libgit2/libgit2.jl b/base/libgit2/libgit2.jl
@@ -510,6 +510,16 @@ The keyword arguments are:
     repository.
 
 Equivalent to `git clone [-b <branch>] [--bare] <repo_url> <repo_path>`.
+
+# Examples
+
+```julia
+repo_url = "https://github.com/JuliaLang/Example.jl"
+repo1 = LibGit2.clone(repo_url, "test_path")
+repo2 = LibGit2.clone(repo_url, "test_path", isbare=true)
+julia_url = "https://github.com/JuliaLang/julia"
+julia_repo = LibGit2.clone(julia_url, "julia_path", branch="release-0.6")
+```
 """
 function clone(repo_url::AbstractString, repo_path::AbstractString;
                branch::AbstractString="",