[doc] Update CLI help snippet: -T# default and --max#4692
Conversation
Fix two outdated claims in programs/README.md's embedded -h snippet: the -T# default has not been 1 for some time (it is now between 1 and 4 based on physical CPU cores, matching zstd.1), and --max was not listed at all. Closes facebook#4687
|
Hi @matysanchez! 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! |
1 participant
Closes #4687
What
Two edits in
programs/README.md:--maxoption under Advanced compression options with its description and the 32-bit mode warning. The option was missing from the README entirely.-T#default from the stale "[Default: 1]" to "[Default: between 1 and 4 depending on physical CPU cores; pass 0 for core count]", reflecting the modern multi-thread default.Scope note
The issue mentions the embedded help text and man page are also affected. This PR fixes the prose surface (programs/README.md) only — the embedded help in the C sources and the man page are best handled in a follow-up or by a maintainer with context on whether they're generated or maintained separately.
Tested
Visual review of the rendered README section; pipe alignment preserved, surrounding option entries untouched.
Verification