Skip to content

Commit 6ab07f7

Browse files
committed
doc: Note that the small feature doesn't include clone
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 #2185 and it may make sense to improve the description further (unless `small` is to change).
1 parent f7c7145 commit 6ab07f7

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ lean = ["fast", "tracing", "pretty-cli", "http-client-curl", "gitoxide-core-tool
5858

5959
## The smallest possible build, best suitable for small single-core machines.
6060
##
61-
## This build is essentially limited to local operations without any fanciness.
61+
## This build is essentially limited to local operations without any fanciness. It does not have `gix clone`.
6262
##
6363
## Optimized for size, no parallelism thus much slower, progress line rendering.
6464
small = ["pretty-cli", "prodash-render-line", "is-terminal"]

0 commit comments

Comments
 (0)