Repository navigation
docs: clarify --fast level bounds and selection - #4844
FOWEPJF255 wants to merge 1 commit into
Conversation
|
Hi @FOWEPJF255! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
What and why
Addresses #4716. The
--fastmanual currently describes the speed/ratio trade-off but leaves the accepted range and out-of-range behavior unclear. This documents that#must be positive, that values above the linked library's maximum are clamped, and that--fast=1and--fast=4are useful starting points to benchmark on the user's data.The bounds and clamping wording follows
ZSTD_minCLevel()and the--fastparser inprograms/zstdcli.c. The two example levels are already used in the README benchmark table. This is complementary to #4663, which notes that--fastmaps to negative library compression levels.Checklist
Validation
ZSTD_minCLevel()implementation, and README examples against the wording.git diff --checkpassed.Tools used
OpenAI Codex was used to inspect the source and draft this documentation. The final wording and source references were checked against the repository files.