Require libgit2 1.4.0+. Remove data_buffer methods #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change is slightly backward incompatible. libgit2 1.4.0 made a chagne to the `git_buf` structure and deprecated a bunch of associated functions, to the effect that `git_buf` is no longer modifiable by users. It is expected that `git_buf` should only be set by libgit2 itself as a return from various functions. So this change to the `data_buffer` class removes all modifier methods. A data_buffer is returned where libgit2 returns a `git_buf`, but we no longer allow the caller to modify the buffer data or grow the buffer. related: libgit2/libgit2#6078 Perhaps we should change methods returning a `data_buffer` to return a `std::string` instead?
craigds
changed the title
olsen232
approved these changes
Mar 2, 2022
There was a problem hiding this comment.
LGTM - I'd say, deprecating/removing those functions is unavoidable and in line with the deprecations that libgit2 has made. Switching the type from data_buffer to std::string seems unnecessarily disruptive to clients - I wouldn't do it unless you want to release a new totally incompatible version where you have tidied up the API as you see fit.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This change is slightly backward incompatible. libgit2 1.4.0 made a
chagne to the
git_bufstructure and deprecated a bunch of associatedfunctions, to the effect that
git_bufis no longer modifiable byusers. It is expected that
git_bufshould only be set by libgit2itself as a return from various functions.
So this change to the
data_bufferclass removes all modifier methods.A data_buffer is returned where libgit2 returns a
git_buf, but we nolonger allow the caller to modify the buffer data or grow the buffer.
related: libgit2/libgit2#6078
Perhaps we should change methods returning a
data_bufferto return astd::stringinstead?