Note that the small feature doesn't include clone
#2186
Merged
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
The `small` feature of the `gitoxide` crate does not directly or indirectly include the `gitoxide-core-blocking-client` feature, and therefore does not provide `gix clone`. Although it was documented to provide only local operations, this was ambiguous: in the sense of local and remote repository operations, cloning is arguably a remote operation even when one clones from a filesystem path, or file URL. But in the broader meaning of "local," this could mean merely that network transport is omitted and that local cloning is included. This adds a short explicit note that `small` does not include `gix clone`. This is a minimal fix for GitoxideLabs#2185 and it may make sense to improve the description further (unless `small` is to change).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #2185
The
smallfeature of thegitoxidecrate does not directly or indirectly include thegitoxide-core-blocking-clientfeature, and therefore does not providegix clone. Although it was documented to provide only local operations, this was ambiguous: in the sense of local and remote repository operations, cloning is arguably a remote operation even when one clones from a filesystem path, or file URL. But in the broader meaning of "local," this could mean merely that network transport is omitted and that local cloning is included.This adds a short explicit note that
smalldoes not includegix clone. This is a minimal fix for #2185 and it may make sense to improve the description further (unlesssmallis to change).