Update README regarding potential kernel build failures

This commit is contained in:
Lan Tian 2025-12-12 19:09:54 -08:00
parent d0d2a987c8
commit 3e8b78b158
No known key found for this signature in database
GPG Key ID: 04E66B6B25A0862B

View File

@ -15,6 +15,21 @@ This repo provides the latest kernel version and the latest LTS kernel version:
├───linux-cachyos-latest-lto ├───linux-cachyos-latest-lto
├───linux-cachyos-lts ├───linux-cachyos-lts
└───linux-cachyos-lts-lto └───linux-cachyos-lts-lto
# Additional CachyOS kernel variants
├───linux-cachyos-bmq
├───linux-cachyos-bmq-lto
├───linux-cachyos-bore
├───linux-cachyos-bore-lto
├───linux-cachyos-deckify
├───linux-cachyos-deckify-lto
├───linux-cachyos-eevdf
├───linux-cachyos-eevdf-lto
├───linux-cachyos-hardened
├───linux-cachyos-hardened-lto
├───linux-cachyos-rt-bore
├───linux-cachyos-rt-bore-lto
├───linux-cachyos-server
├───linux-cachyos-server-lto
``` ```
The kernel versions are automatically kept in sync with Nixpkgs, so once the latest/LTS kernel is updated in Nixpkgs, CachyOS kernels in this repo will automatically catch up. The kernel versions are automatically kept in sync with Nixpkgs, so once the latest/LTS kernel is updated in Nixpkgs, CachyOS kernels in this repo will automatically catch up.
@ -64,6 +79,16 @@ Then specify `pkgs.cachyosKernels.linuxPackages-cachyos-latest` (or other varian
} }
``` ```
### Help! My kernel is failing to build!
In most cases, failing to build a kernel is caused by CachyOS not updating patches for the latest kernel version. (e.g. hardened 6.18 kernel as of 2025-12-12)
Common symptoms are:
- "File not found" error, which indicates that CachyOS patches for given kernel version/variant are unavailable.
- Failures/conflicts when applying patches, which indicates that CachyOS patches are for an older kernel version.
If this is the case, the only option is to wait for CachyOS team to update the patches.
## How to use ZFS modules ## How to use ZFS modules
> Note: CachyOS-patched ZFS module may fail to compile from time to time. Most compilation failures are caused by incompatibilities between kernel and ZFS. Please check [ZFS upstream issues](https://github.com/openzfs/zfs/issues) for any compatibility reports, and try switching between `zfs_2_3`, `zfs_unstable` and `zfs_cachyos`. > Note: CachyOS-patched ZFS module may fail to compile from time to time. Most compilation failures are caused by incompatibilities between kernel and ZFS. Please check [ZFS upstream issues](https://github.com/openzfs/zfs/issues) for any compatibility reports, and try switching between `zfs_2_3`, `zfs_unstable` and `zfs_cachyos`.
@ -120,6 +145,10 @@ If you want to construct your own `linuxPackages` attrset with `linuxKernel.pack
} }
``` ```
### Help! My ZFS module is failing to build!
In most cases, failing to build ZFS module is caused by CachyOS not updating patches for the latest kernel version. The only option is to wait for CachyOS team to update the patches.
## How to apply CachyOS patches on your own kernel ## How to apply CachyOS patches on your own kernel
The kernels provided in this flake can be overridden to use your own kernel source. This is helpful if you want to use a kernel version not available in Nixpkgs. The kernels provided in this flake can be overridden to use your own kernel source. This is helpful if you want to use a kernel version not available in Nixpkgs.