| 1 | # Zstd in the Linux Kernel |
| 2 | |
| 3 | This directory contains the scripts needed to transform upstream zstd into the version imported into the kernel. All the transforms are automated and tested by our continuous integration. |
| 4 | |
| 5 | ## Upgrading Zstd in the Linux Kernel |
| 6 | |
| 7 | 1. `cd` into this directory. |
| 8 | 2. Run `make libzstd` and read the output. Make sure that all the diffs printed and changes made by the script are correct. |
| 9 | 3. Run `make test` and ensure that it passes. |
| 10 | 4. Import zstd into the Linux Kernel `make import LINUX=/path/to/linux/repo` |
| 11 | 5. Inspect the diff for sanity. |
| 12 | 6. Check the Linux Kernel history for zstd. If any patches were made to the kernel version of zstd, but not to upstream zstd, then port them upstream if necessary. |
| 13 | 7. Test the diff. Benchmark if necessary. Make sure to test multiple architectures: At least x86, i386, and arm. |
| 14 | 8. Submit the patch to the LKML. |