From 0dd7792b4cdfba6ee700864919f358187163e850 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Thu, 28 Jul 2022 16:42:55 +0200 Subject: [PATCH] nixpkgs/doc: remove unused `unfree.xml` This section was broken out into its own file in efb55d2a42e but apparently never actually got included anywhere. Since then a more detailed section on using unfree packages has been introduced. Copied the introduction and removed the rest of the file. --- doc/builders/packages/unfree.xml | 13 ------------- doc/using/configuration.chapter.md | 5 +++++ 2 files changed, 5 insertions(+), 13 deletions(-) delete mode 100644 doc/builders/packages/unfree.xml diff --git a/doc/builders/packages/unfree.xml b/doc/builders/packages/unfree.xml deleted file mode 100644 index 3d4f199f8fb0..000000000000 --- a/doc/builders/packages/unfree.xml +++ /dev/null @@ -1,13 +0,0 @@ -
- Unfree software - - - All users of Nixpkgs are free software users, and many users (and developers) of Nixpkgs want to limit and tightly control their exposure to unfree software. At the same time, many users need (or want) to run some specific pieces of proprietary software. Nixpkgs includes some expressions for unfree software packages. By default unfree software cannot be installed and doesn’t show up in searches. To allow installing unfree software in a single Nix invocation one can export NIXPKGS_ALLOW_UNFREE=1. For a persistent solution, users can set allowUnfree in the Nixpkgs configuration. - - - - Fine-grained control is possible by defining allowUnfreePredicate function in config; it takes the mkDerivation parameter attrset and returns true for unfree packages that should be allowed. - -
diff --git a/doc/using/configuration.chapter.md b/doc/using/configuration.chapter.md index 2445aa32f2a7..3c46dc3227a6 100644 --- a/doc/using/configuration.chapter.md +++ b/doc/using/configuration.chapter.md @@ -77,6 +77,11 @@ The difference between a package being unsupported on some system and being brok ## Installing unfree packages {#sec-allow-unfree} +All users of Nixpkgs are free software users, and many users (and developers) of Nixpkgs want to limit and tightly control their exposure to unfree software. +At the same time, many users need (or want) to run some specific pieces of proprietary software. +Nixpkgs includes some expressions for unfree software packages. +By default unfree software cannot be installed and doesn’t show up in searches. + There are several ways to tweak how Nix handles a package which has been marked as unfree. - To temporarily allow all unfree packages, you can use an environment variable for a single invocation of the nix tools: