diff options
author | Silvan Mosberger <silvan.mosberger@tweag.io> | 2023-09-28 16:25:43 +0200 |
---|---|---|
committer | Silvan Mosberger <silvan.mosberger@tweag.io> | 2023-09-28 16:27:33 +0200 |
commit | 11406bdc0e5af9b3c8a8d597da23349238c65277 (patch) | |
tree | c53f9fc5f0819e742672c6506dbfeb10f6dc8a25 /nixos/modules/misc | |
parent | ec72e4f98aebcba83701b32343960b0788948921 (diff) | |
download | nixpkgs-11406bdc0e5af9b3c8a8d597da23349238c65277.tar nixpkgs-11406bdc0e5af9b3c8a8d597da23349238c65277.tar.gz nixpkgs-11406bdc0e5af9b3c8a8d597da23349238c65277.tar.bz2 nixpkgs-11406bdc0e5af9b3c8a8d597da23349238c65277.tar.lz nixpkgs-11406bdc0e5af9b3c8a8d597da23349238c65277.tar.xz nixpkgs-11406bdc0e5af9b3c8a8d597da23349238c65277.tar.zst nixpkgs-11406bdc0e5af9b3c8a8d597da23349238c65277.zip |
nixos/nixpkgs: Rewrite overlays option docs
henrik-ch was also here :) Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io>
Diffstat (limited to 'nixos/modules/misc')
-rw-r--r-- | nixos/modules/misc/nixpkgs.nix | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/nixos/modules/misc/nixpkgs.nix b/nixos/modules/misc/nixpkgs.nix index f9d8bccea28..cc5f5742109 100644 --- a/nixos/modules/misc/nixpkgs.nix +++ b/nixos/modules/misc/nixpkgs.nix @@ -176,16 +176,12 @@ in ''; type = types.listOf overlayType; description = lib.mdDoc '' - 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. - - If `nixpkgs.pkgs` is set, overlays specified here - will be applied after the overlays that were already present - in `nixpkgs.pkgs`. + List of overlays to apply to Nixpkgs. + This option allows modifying the Nixpkgs package set accessed through the `pkgs` module argument. + + 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`. ''; }; |