zstd/contrib/linux-kernel
Yann Collet 04a2a0219c update type names
naming convention: Type names should start with a Capital letter (after the prefix)
2024-12-29 14:25:33 -08:00
..
test Coalesce Almost All Copyright Notices to Standard Phrasing 2022-12-20 12:52:34 -05: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
decompress_sources.h Update Copyright Headers 'Facebook' -> 'Meta Platforms' 2022-12-20 12:37:57 -05:00
linux.mk Update Copyright Headers 'Facebook' -> 'Meta Platforms' 2022-12-20 12:37:57 -05:00
linux_zstd.h update type names 2024-12-29 14:25:33 -08:00
Makefile Delete unused Huffman functions 2023-01-20 14:12:53 -08:00
mem.h fixed MEM_STATIC already defined in Linux Kernel mode 2023-06-14 20:07:18 -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_common_module.c Fix zstd-dll build missing dependencies (#3496) 2023-02-12 12:32:31 -08:00
zstd_compress_module.c Expose size estimation helpers for Linux (#4064) 2024-06-14 14:38:48 -04:00
zstd_decompress_module.c [linux] Remove usage of deprecated function 2023-11-17 09:54:10 -08:00
zstd_deps.h [linux] Backport intptr_t removal 2023-11-17 09:54:10 -08:00

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.