Username404-59/nix-cachyos-kernel
1
0
Fork 0
mirror of https://github.com/xddxdd/nix-cachyos-kernel.git synced 2026-07-03 19:18:07 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README regarding default/pinned overlay

Browse Source
This commit is contained in:
Lan Tian 2026-03-09 19:43:18 -07:00
parent 2cfbfbcc78
commit 6f31cdcda5
No known key found for this signature in database
GPG Key ID: 04E66B6B25A0862B
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -102,14 +102,14 @@ Add the repo's overlay in your NixOS configuration, this will expose the package
{ pkgs, ... }: { pkgs, ... }:
{ {
nixpkgs.overlays = [ nixpkgs.overlays = [
# Use the exact kernel versions as defined in this repo. # Use nixpkgs from your environment, nixpkgs.config will apply.
# Guarantees you have binary cache. # Has small chance of kernel modules not being compatible with kernel version.
nix-cachyos-kernel.overlays.pinned
# Alternatively, build the kernels on top of nixpkgs version in your flake.
# This might cause version mismatch/build failures!
nix-cachyos-kernel.overlays.default nix-cachyos-kernel.overlays.default
# Alternatively, use the exact nixpkgs revison as defined in this repo.
# Guarantees you have binary cache, but initializes another nixpkgs instance.
nix-cachyos-kernel.overlays.pinned
# Only use one of the two overlays! # Only use one of the two overlays!
]; ];
@ -124,6 +124,17 @@ Add the repo's overlay in your NixOS configuration, this will expose the package
Then specify `pkgs.cachyosKernels.linuxPackages-cachyos-latest` (or other variants you'd like) in your `boot.kernelPackages` option. Then specify `pkgs.cachyosKernels.linuxPackages-cachyos-latest` (or other variants you'd like) in your `boot.kernelPackages` option.
> Note: Previously I recommended the `pinned` overlay, as nix-cachyos-kernel applies patches on top of the latest kernel available in nixpkgs, and with `default` overlay there might be a version mismatch between nixpkgs and nix-cachyos-kernel. This is no longer the case since 2026-03-01 when [nix-cachyos-kernel switched to pre-patched kernel source released by CachyOS](https://github.com/xddxdd/nix-cachyos-kernel/commit/a3da9122076ae33d52828d1e6c4a2595378f0ca2). Now the kernel versions are defined in nix-cachyos-kernel instead of depending on nixpkgs, so the `default` overlay is safe to use as well.
>
> Use `default` if:
> - You want to avoid initializing multiple instances of nixpkgs.
> - You want to use latest kernel modules that are just merged/updated within nixpkgs.
> - You want to customize `nixpkgs.config` options.
>
> Use `pinned` if:
> - You want to ensure that you can fetch kernel from binary cache.
> - You want to make sure that the kernel can be built successfully.
### Binary cache ### Binary cache
The two binary caches will be automatically suggested The two binary caches will be automatically suggested