summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorSebastian Jordan <sebastian.jordan.mail@googlemail.com>2015-04-20 22:48:28 +0200
committerSebastian Jordan <sebastian.jordan.mail@googlemail.com>2015-04-23 17:11:38 +0200
commit20dadec2642c9b449dffd26aac50687ffeaef243 (patch)
treedad06dd5bd7cb3ce3c7ca3e8f4ac6b144bd696dd /doc
parent8a78dcc00ff87dc985ad15305b0ebd6739863827 (diff)
downloadnixpkgs-20dadec2642c9b449dffd26aac50687ffeaef243.tar
nixpkgs-20dadec2642c9b449dffd26aac50687ffeaef243.tar.gz
nixpkgs-20dadec2642c9b449dffd26aac50687ffeaef243.tar.bz2
nixpkgs-20dadec2642c9b449dffd26aac50687ffeaef243.tar.lz
nixpkgs-20dadec2642c9b449dffd26aac50687ffeaef243.tar.xz
nixpkgs-20dadec2642c9b449dffd26aac50687ffeaef243.tar.zst
nixpkgs-20dadec2642c9b449dffd26aac50687ffeaef243.zip
Reduce verbosity of packageOverrides description.
Diffstat (limited to 'doc')
-rw-r--r--doc/packageconfig.xml35
1 files changed, 7 insertions, 28 deletions
diff --git a/doc/packageconfig.xml b/doc/packageconfig.xml
index cebbd5bf772..ec65fea6cc4 100644
--- a/doc/packageconfig.xml
+++ b/doc/packageconfig.xml
@@ -4,8 +4,6 @@
 
 <title><filename>~/.nixpkgs/config.nix</filename>: global configuration</title>
 
-<section><title>Allow unfree software</title>
-
     <para>
       Nix packages can be configured to allow or deny certain options.
     </para>
@@ -68,37 +66,18 @@
 	A complete list of licenses can be found in the file
 	<filename>lib/licenses.nix</filename> of the nix package tree.
     </para>
-</section>
 
-<section><title>Overriding existing packages</title>
+<section><title>Modify packages via<literal>packageOverrides</literal></title>
 
 <para>
   <filename>~/.nixpkgs/config.nix</filename> enables the user to
-  override package names without creating a fork of the Nixpkgs.
-  This is accomplished by defining a function called
-  <varname>packageOverrides</varname>.  It takes the set of
-  packages, usually called <varname>pkgs</varname>, and returns a
-  modified set of packages.
-</para>
-<para>
-  Here is an example.  Say we want to install
-  <varname>xbmc</varname> but we want to use another Python
-  version when running <varname>xbmc</varname>.
-
-<programlisting>
-packageOverrides = pkgs: rec {
-  xbmc = pkgs.xbmc.override {
-    python = pkgs.python26;
-  };
-};
-</programlisting>
-
-  Further information is available at the <command
-  xlink:href="https://nixos.org/wiki/Nix_Modifying_Packages">Nix
-  wiki</command>
-
+  override package names without creating a fork of Nixpkgs.  This is
+  accomplished by defining a function called
+  <varname>packageOverrides</varname>.  It is expected to take the set
+  of packages, usually called <varname>pkgs</varname>, and returns a
+  modified set of packages.  It is called when evaluating any nix
+  expression in the <varname>pkgs</varname> set.
 </para>
-
 </section>
 
 </chapter>