From 9b7654f6ff326a7e35b48ce3c54d7f8bb71d9a13 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Mon, 15 Oct 2018 13:47:36 +0200 Subject: nixpkgs docs: Point to pkgs.extend, pkgs.appendOverlays and improve override section --- doc/functions/overrides.xml | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'doc/functions') diff --git a/doc/functions/overrides.xml b/doc/functions/overrides.xml index 99e2a63631a..30cc6f3f6b1 100644 --- a/doc/functions/overrides.xml +++ b/doc/functions/overrides.xml @@ -6,8 +6,16 @@ Sometimes one wants to override parts of nixpkgs, e.g. - derivation attributes, the results of derivations or even the whole package - set. + derivation attributes, the results of derivations. + + + + These overriding functions let you focus on one part of Nixpkgs and give you + back the requested variation. This is orthogonal but related to overlays and + the extending functions. Those also let you make modifications but return the + whole package set instead of just what you modified. When used together, the + override functions make the changes and overlays or extending functions add + those changes to the package sets.
@@ -25,6 +33,9 @@ Example usages: pkgs.foo.override { arg1 = val1; arg2 = val2; ... } + import pkgs.path { overlays = [ (self: super: { foo = super.foo.override { barSupport = true ; }; -- cgit v1.2.3 From 3c2ae189c2af388812d82596770df74ac8f839ee Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Thu, 18 Oct 2018 14:01:06 +0200 Subject: doc: Improve overrides and overlays documentation --- doc/functions/overrides.xml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) (limited to 'doc/functions') diff --git a/doc/functions/overrides.xml b/doc/functions/overrides.xml index 30cc6f3f6b1..5532951d1a7 100644 --- a/doc/functions/overrides.xml +++ b/doc/functions/overrides.xml @@ -10,12 +10,9 @@ - These overriding functions let you focus on one part of Nixpkgs and give you - back the requested variation. This is orthogonal but related to overlays and - the extending functions. Those also let you make modifications but return the - whole package set instead of just what you modified. When used together, the - override functions make the changes and overlays or extending functions add - those changes to the package sets. + These functions are used to make changes to packages, returning only single + packages. Overlays, on the other hand, can be used to combine the overridden + packages across the entire package set of Nixpkgs.
-- cgit v1.2.3 From a5c4642ddf03f792c29764c53725f9b04e06decd Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Fri, 19 Oct 2018 12:25:17 +0200 Subject: doc: Add link from overrides to overlays --- doc/functions/overrides.xml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'doc/functions') diff --git a/doc/functions/overrides.xml b/doc/functions/overrides.xml index 5532951d1a7..4ba861bd1a4 100644 --- a/doc/functions/overrides.xml +++ b/doc/functions/overrides.xml @@ -11,8 +11,9 @@ These functions are used to make changes to packages, returning only single - packages. Overlays, on the other hand, can be used to combine the overridden - packages across the entire package set of Nixpkgs. + packages. Overlays, on the other + hand, can be used to combine the overridden packages across the entire + package set of Nixpkgs.
-- cgit v1.2.3