From 3cd3a79f9ba7f6c3421f4f7fd557b4c8666e7183 Mon Sep 17 00:00:00 2001 From: Emily Date: Mon, 3 Feb 2025 19:31:14 +0000 Subject: [PATCH] nixpkgs: Rewrite overlays option docs henrik-ch was also here :) Backport of Nixpkgs commit 11406bdc0e5af9b3c8a8d597da23349238c65277. Co-authored-by: Silvan Mosberger Co-Authored-By: Valentin Gagarin --- modules/nix/nixpkgs.nix | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/modules/nix/nixpkgs.nix b/modules/nix/nixpkgs.nix index 2ed7b8da..4e876beb 100644 --- a/modules/nix/nixpkgs.nix +++ b/modules/nix/nixpkgs.nix @@ -151,16 +151,12 @@ in ''; type = types.listOf overlayType; description = '' - List of overlays to use with the Nix Packages collection. - (For details, see the Nixpkgs documentation.) It allows - you to override packages globally. Each function in the list - takes as an argument the *original* Nixpkgs. - The first argument should be used for finding dependencies, and - the second should be used for overriding recipes. + List of overlays to apply to Nixpkgs. + This option allows modifying the Nixpkgs package set accessed through the `pkgs` module argument. - If `nixpkgs.pkgs` is set, overlays specified here - will be applied after the overlays that were already present - in `nixpkgs.pkgs`. + For details, see the [Overlays chapter in the Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#chap-overlays). + + If the {option}`nixpkgs.pkgs` option is set, overlays specified using `nixpkgs.overlays` will be applied after the overlays that were already included in `nixpkgs.pkgs`. ''; };