diff options
Diffstat (limited to '3rdparty/zstd/contrib/linux-kernel/README.md')
-rw-r--r-- | 3rdparty/zstd/contrib/linux-kernel/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/3rdparty/zstd/contrib/linux-kernel/README.md b/3rdparty/zstd/contrib/linux-kernel/README.md new file mode 100644 index 00000000000..bfa070d1794 --- /dev/null +++ b/3rdparty/zstd/contrib/linux-kernel/README.md @@ -0,0 +1,14 @@ +# Zstd in the Linux Kernel + +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. + +## Upgrading Zstd in the Linux Kernel + +1. `cd` into this directory. +2. Run `make libzstd` and read the output. Make sure that all the diffs printed and changes made by the script are correct. +3. Run `make test` and ensure that it passes. +4. Import zstd into the Linux Kernel `make import LINUX=/path/to/linux/repo` +5. Inspect the diff for sanity. +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. +7. Test the diff. Benchmark if necessary. Make sure to test multiple architectures: At least x86, i386, and arm. +8. Submit the patch to the LKML. |