diff --git a/base/libgit2/status.jl b/base/libgit2/status.jl index ccfb4c8e19985..568676f8eda82 100644 --- a/base/libgit2/status.jl +++ b/base/libgit2/status.jl @@ -7,7 +7,7 @@ Collect information about the status of each file in the git repository `repo` (e.g. is the file modified, staged, etc.). `status_opts` can be used to set various options, for instance whether or not to look at untracked files or whether to include -submodules or not. +submodules or not. See [`StatusOptions`](@ref) for more information. """ function GitStatus(repo::GitRepo; status_opts=StatusOptions()) stat_ptr_ptr = Ref{Ptr{Void}}(C_NULL) diff --git a/base/libgit2/types.jl b/base/libgit2/types.jl index d713b6f94a772..e7fb21bdd0e47 100644 --- a/base/libgit2/types.jl +++ b/base/libgit2/types.jl @@ -748,6 +748,14 @@ end Providing the differences between the file as it exists in HEAD and the index, and providing the differences between the index and the working directory. Matches the `git_status_entry` struct. + +The fields represent: + * `status`: contains the status flags for the file, indicating if it is current, + or has been changed in some way in the index or work tree. + * `head_to_index`: a pointer to a [`DiffDelta`](@ref) which encapsulates the difference(s) + between the file as it exists in HEAD and in the index. + * `index_to_workdir`: a pointer to a `DiffDelta` which encapsulates the difference(s) + between the file as it exists in the index and in the [`workdir`](@ref). """ struct StatusEntry status::Cuint