From ce02ad25edef349f9e4b8aa08cc14a7a601428b6 Mon Sep 17 00:00:00 2001 From: Gavin John Date: Sun, 5 Jan 2025 14:02:54 -0500 Subject: [PATCH] doc/manual: replace bad advice about package options and overlays --- nixos/doc/manual/development/option-declarations.section.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nixos/doc/manual/development/option-declarations.section.md b/nixos/doc/manual/development/option-declarations.section.md index ee4540d0cf6fd..112c4f054f2a2 100644 --- a/nixos/doc/manual/development/option-declarations.section.md +++ b/nixos/doc/manual/development/option-declarations.section.md @@ -99,7 +99,7 @@ mkPackageOption pkgs "name" { default = [ "path" "in" "pkgs" ]; example = "liter Creates an Option attribute set for an option that specifies the package a module should use for some purpose. -**Note**: You shouldn’t necessarily make package options for all of your modules. You can always overwrite a specific package throughout nixpkgs by using [nixpkgs overlays](https://nixos.org/manual/nixpkgs/stable/#chap-overlays). +**Note**: You should make package options for your modules, where applicable. While one can always overwrite a specific package throughout nixpkgs by using [nixpkgs overlays](https://nixos.org/manual/nixpkgs/stable/#chap-overlays), they slow down nixpkgs evaluation significantly and are harder to debug when issues arise. The package is specified in the third argument under `default` as a list of strings representing its attribute path in nixpkgs (or another package set).