Document --fast levels

Open Beginner friendly
#4,716 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
c
Domain
cli, documentation

Research direction

Start with the zstd manpage entry for --fast and compare its documented levels with the limits and guidance in lib/zstd.h around lines 108-109. Document which levels are permitted and which are reasonable, then verify that the manpage clearly explains the available range.

Written by the indexing model from the issue text.

Description

Is your feature request related to a problem? Please describe.
Manpage says --fast can take levels starting at 1, but not which

Describe the solution you'd like
Document what is permitted and also what is reasonable

Describe alternatives you've considered
Leaving it as is

Additional context
https://github.com/facebook/zstd/blob/v1.4.8/lib/zstd.h#L108-L109
Internally looks like 1 << 17 for version I have installed

Dominant language
C
Stars
27.9k
Forks
2.6k
Avg merge
1d 3h
Merged PRs (30d)
8

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from facebook/zstd

All issues in facebook/zstd

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.