Merge pull request #23454 from JuliaLang/ksh/docutils

Docs for libgit2 utils

Author: kshyatt

base/libgit2/utils.jl

@@ -21,6 +21,11 @@ const URL_REGEX = r"""
 $
 """x
 
+"""
+    version() -> VersionNumber
+
+Return the version of libgit2 in use, as a [`VersionNumber`](@ref man-version-number-literals).
+"""
 function version()
     major = Ref{Cint}(0)
     minor = Ref{Cint}(0)
@@ -31,10 +36,34 @@ function version()
 end
 const VERSION = version()
 
+"""
+    isset(val::Integer, flag::Integer)
+
+Test whether the bits of `val` indexed by `flag` are set (`1`) or unset (`0`).
+"""
 isset(val::Integer, flag::Integer) = (val & flag == flag)
+
+"""
+    reset(val::Integer, flag::Integer)
+
+Unset the bits of `val` indexed by `flag`, returning them to `0`.
+"""
 reset(val::Integer, flag::Integer) = (val &= ~flag)
+
+"""
+    toggle(val::Integer, flag::Integer)
+
+Flip the bits of `val` indexed by `flag`, so that if a bit is `0` it
+will be `1` after the toggle, and vice-versa.
+"""
 toggle(val::Integer, flag::Integer) = (val |= flag)
 
+"""
+    features()
+
+Return a list of git features the current version of libgit2 supports, such as
+threading or using HTTPS or SSH.
+"""
 function features()
     feat = ccall((:git_libgit2_features, :libgit2), Cint, ())
     res = Consts.GIT_FEATURE[]

doc/src/devdocs/libgit2.md

@@ -82,6 +82,7 @@ Base.LibGit2.merge_base
 Base.LibGit2.merge!(::Base.LibGit2.GitRepo; ::Any...)
 Base.LibGit2.ffmerge!
 Base.LibGit2.fullname
+Base.LibGit2.features
 Base.LibGit2.get_creds!
 Base.LibGit2.gitdir
 Base.LibGit2.head
@@ -95,6 +96,7 @@ Base.LibGit2.iscommit
 Base.LibGit2.isdiff
 Base.LibGit2.isdirty
 Base.LibGit2.isorphan
+Base.LibGit2.isset
 Base.LibGit2.lookup_branch
 Base.LibGit2.map(::Function, ::Base.LibGit2.GitRevWalker; ::Base.LibGit2.GitHash, ::Cint, ::Bool)
 Base.LibGit2.mirror_callback
@@ -116,6 +118,7 @@ Base.LibGit2.ref_list
 Base.LibGit2.reftype
 Base.LibGit2.remotes
 Base.LibGit2.remove!
+Base.LibGit2.reset
 Base.LibGit2.reset!
 Base.LibGit2.restore
 Base.LibGit2.revcount
@@ -128,11 +131,13 @@ Base.LibGit2.tag_create
 Base.LibGit2.tag_delete
 Base.LibGit2.tag_list
 Base.LibGit2.target
+Base.LibGit2.toggle
 Base.LibGit2.transact
 Base.LibGit2.treewalk
 Base.LibGit2.upstream
 Base.LibGit2.update!
 Base.LibGit2.url
+Base.LibGit2.version
 Base.LibGit2.with
 Base.LibGit2.workdir
 ```