Lines Matching full:zstd

30 Zstd uses a branch-based workflow for making changes to the codebase. Typically, zstd
37         * Checkout your fork of zstd if you have not already
39         git checkout https://github.com/<username>/zstd
40         cd zstd
44         git pull https://github.com/facebook/zstd dev
99 …* Eventually, someone from the zstd team will approve your pull request and not long after merge i…
106 …     that the change must make it to an official zstd release for it to be meaningful. We recommend
108 …  their change makes it to the next release of zstd. Users will often discover bugs in your code or
113 executing it. It usually helps us find many simple bugs. Zstd uses clang's `scan-build` tool for
152 branch of zstd. You can then find the status of the tests on the PR's page. You can also
155 Almost all of zstd's CI runs on GitHub Actions (configured at `.github/workflows`), which will auto…
164 these up on your fork in order to contribute to zstd; however, we do link to instructions for those
175 The general idea should be the same for setting up CI on your fork of zstd, but you may have to 
177 config files (since zstd already has configs for each of these services).
180 Performance is extremely important for zstd and we only merge pull requests whose performance
187 1. Zstd isn't as old as gzip but it has been around for time now and its evolution is
203 legitimate thing to do as long as it does not harm the overall performance health of Zstd.
204 This is a hard balance to strike but please keep in mind other aspects of Zstd when
208 Performance microbenchmarking is a tricky subject but also essential for Zstd. We value empirical
259 be enabled by default when building zstd.
268 ### Zstd benchmark
269 The fastest signal you can get regarding your performance changes is via the in-build zstd cli
270 bench option. You can run Zstd as you typically would for your scenario using some set of options
275 For example: say you have made a change that you believe improves the speed of zstd level 1. The
277 is `zstd -b`. You might try to do something like this. Note: you can use the `-i` option to
283 $ make && cp zstd zstd-old
285 $ make && cp zstd zstd-new
286 $ zstd-old -i5 -b1 <your-test-data>
288 $ zstd-new -i5 -b1 <your-test-data>
305 for level 1 compression on Zstd. Typically this means, you have identified a section of
335 $ zstd -b1 -i5 <my-data> # this will run for 5 seconds
341     `zstd`
349     zstd and your benchmarking script using debug flags. On mac and linux, this just means
390 The following is a non-exhaustive list of rules employed in zstd code base: