Add docs about Repository::index ownership. #922
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When doing something like
let index = Repository::open("foo")?.index()?;
, the resultingindex
can't do very much since many of its methods will fail (with errors likeThis operation is not allowed against bare repositories
). This adds some documentation about this behavior.There are some alternate solutions here, but I didn't find them very palatable:
Index
. This might be a little awkward (use'static
for non-repo Indexes?).Repository::index()
. This I think would make theIndex
a little more awkward to use, and seems a little overkill.Index
methods for a NULLgit_index_owner()
that need an owner, and provide a better error message.There are a few other "owned" types, including
git_odb
,git_refdb
, andgit_config
. However, those don't seem to have the same issues asgit_index
, since they are mostly revolved around caching.I think adding a lifetime is still an option, but I figure this would be a good solution for now.
closes #897