History

Nick Terrell 3420c202af [linux-kernel] Update README with initial instructions on how to update zstd in the kernel		2020-09-09 14:36:22 -07:00
..
test	[linux-kernel] Add test that checks the ifdef hardwiring	2020-09-09 14:36:19 -07:00
.gitignore	fix gitignore	2017-04-04 18:15:21 -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
linux.mk	Add linux-kernel freestanding	2020-09-09 14:35:57 -07:00
Makefile	[linux-kernel] Add test that checks the ifdef hardwiring	2020-09-09 14:36:19 -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
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	Add linux-kernel freestanding	2020-09-09 14:35:57 -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

cd into this directory.
Run make libzstd and read the output. Make sure that all the diffs printed and changes made by the script are correct.
Run make test and ensure that it passes.
Import zstd into the Linux Kernel make import LINUX=/path/to/linux/repo
Inspect the diff for sanity.
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.
Test the diff. Benchmark if necessary. Make sure to test multiple architectures: At least x86, i386, and arm.
Submit the patch to the LKML.