Skip to content

Commit

Permalink
Merge pull request #23517 from JuliaLang/ksh/docstatus
Browse files Browse the repository at this point in the history
Doc statusentry and add xrefs
  • Loading branch information
kshyatt authored Aug 31, 2017
2 parents 8f6f5aa + 104a81c commit 88b6487
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
2 changes: 1 addition & 1 deletion base/libgit2/status.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions base/libgit2/types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 88b6487

Please sign in to comment.