digint / digint/btrbk

Document `stream_compress_adapt` has co-requisites to function

Open
#616 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Perl
Stars
2.1k
Forks
139
PR merge metrics
No merged PRs in 30d

Description

Document `zstd`-specific `stream_compress_adapt` requires the following to work:
- `stream_compress_long` active (see #615)
- `stream_compress_threads` (set to `0` for zstd auto-detect CPU cores)

`man zstd` says:

```
• --adapt[=min=#,max=#]: zstd will dynamically adapt compression level to
perceived I/O conditions. Compression level adaptation can be observed live
by using command -v. Adaptation can be constrained between supplied min and
max levels. The feature works when combined with multi-threading and --long
mode. It does not work with --single-thread. It sets window size to 8 MiB
by default (can be changed manually, see wlog). Due to the chaotic nature
of dynamic adaptation, compressed result is not reproducible.
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the repository for `stream_compress_adapt`, `stream_compress_long`, and `stream_compress_threads` to find the relevant documentation entry. Confirm the documented prerequisites and zstd limitations against the issue text and `man zstd`; the work is done when users can see the required co-requisites and incompatible mode.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.