facebook
/
zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
zstd/contrib/linux-kernel
History
sen 698f261b35
[1.5.0] Deprecate some functions (#2582) 
* Add deprecated macro to zstd.h, mark certain functions as deprecated

* Remove ZSTD_compress.c dependencies on deprecated functions
 		2021-05-06 17:59:32 -04:00
..
test [1.5.0] Deprecate some functions (#2582) 2021-05-06 17:59:32 -04:00
.gitignore fix gitignore 2017-04-04 18:15:21 -07:00
Makefile [1.5.0] Move `zstd_errors.h` and `zdict.h` to `lib/` root 2021-04-30 15:13:54 -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 [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
linux.mk [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
linux_zstd.h [contrib][linux-kernel] Add zstd_min_clevel() and zstd_max_clevel() 2021-03-30 10:30:59 -07:00
mem.h [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
squashfs-benchmark.sh [kernel] Update README with SquashFS patch 2017-05-03 11:07:39 -07:00
zstd_compress_module.c [contrib][linux-kernel] Add zstd_min_clevel() and zstd_max_clevel() 2021-03-30 10:30:59 -07:00
zstd_decompress_module.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
zstd_deps.h [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -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.