zstd/contrib/linux-kernel
Cyber Knight 498ac8238d
[contrib][linux] Make zstd_reset_cstream() functionally identical to ZSTD_resetCStream()
- As referenced by Nick Terrelln ~ the ZSTD maintainer in the linux kernel, making zstd_reset_cstream() functionally identical to ZSTD_resetCStream() would be the perfect way to fix the warning without touching any core functions or breaking other parts of the code.

Suggested-by: Nick Terrell <terrelln@fb.com>
Signed-off-by: Cyber Knight <cyberknight755@gmail.com>
2022-03-10 15:32:13 +08:00
..
test [build][asm] Pass ASFLAGS to the assembler instead of CFLAGS 2022-01-18 15:11:29 -08:00
.gitignore fix gitignore 2017-04-04 18:15:21 -07:00
Makefile [linux-kernel] Don't inline function in zstd_opt.c 2021-11-15 20:37:30 -08: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 [asm] Share portability macros and restrict ASM further 2021-12-02 16:58:04 -08:00
linux.mk [linux-kernel] Don't add -O3 to CFLAGS 2021-11-16 15:42:36 -08:00
linux_zstd.h [contrib][linux] Fix up SPDX license identifiers 2021-09-22 15:09:42 -07:00
mem.h Add typedefs for 8bit (un)signed 2021-12-14 23:47:57 +01:00
squashfs-benchmark.sh [kernel] Update README with SquashFS patch 2017-05-03 11:07:39 -07:00
zstd_compress_module.c [contrib][linux] Make zstd_reset_cstream() functionally identical to ZSTD_resetCStream() 2022-03-10 15:32:13 +08:00
zstd_decompress_module.c [contrib][linux] Fix up SPDX license identifiers 2021-09-22 15:09:42 -07:00
zstd_deps.h [contrib][linux] Fix up SPDX license identifiers 2021-09-22 15:09:42 -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.