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

Doc statusentry and add xrefs #23517

Merged
merged 1 commit into from
Aug 31, 2017
Merged

Doc statusentry and add xrefs #23517

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
2 changes: 1 addition & 1 deletion base/libgit2/status.jl
View file
Open in desktop
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
View file
Open in desktop
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