facebook
/
zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
zstd/contrib/linux-kernel
History
Nick Terrell 6a1e526ea7 [lib] Add ZSTD_COMPRESS_HEAPMODE tuning parameter 2020-09-24 19:42:04 -07:00
..
test [linux-kernel] Avoid including <string.h> in the tests 2020-09-24 19:42:04 -07:00
.gitignore fix gitignore 2017-04-04 18:15:21 -07:00
Makefile [lib] Add ZSTD_COMPRESS_HEAPMODE tuning parameter 2020-09-24 19:42:04 -07:00
README.md [linux-kernel] Update README with initial instructions on how to update zstd in the kernel 2020-09-09 14:36:22 -07:00
btrfs-benchmark.sh Add BtrFS benchmarks 2017-04-11 12:40:53 -07:00
btrfs-extract-benchmark.sh [linux] Write all the patch summaries 2017-06-21 20:23:44 -07:00
decompress_sources.h [contrib][linux-kernel] Add decompress_sources.h 2020-09-14 12:49:23 -07:00
linux.mk Add linux-kernel freestanding 2020-09-09 14:35:57 -07:00
mem.h Reorganize zstd_deps.h and mem.h + replace mem.h for the kernel 2020-09-24 19:41:59 -07:00
squashfs-benchmark.sh [kernel] Update README with SquashFS patch 2017-05-03 11:07:39 -07:00
zstd_compress_module.c Add linux-kernel freestanding 2020-09-09 14:35:57 -07:00
zstd_decompress_module.c Add linux-kernel freestanding 2020-09-09 14:35:57 -07:00
zstd_deps.h Reorganize zstd_deps.h and mem.h + replace mem.h for the kernel 2020-09-24 19:41:59 -07:00

README.md

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.