diff options
| author | Robert Hensing <robert@roberthensing.nl> | 2022-05-01 21:43:10 +0200 |
|---|---|---|
| committer | Robert Hensing <robert@roberthensing.nl> | 2022-05-02 10:21:05 +0200 |
| commit | e40d2099d235f80aa3444b7a76028c0b7725a549 (patch) | |
| tree | cd4c49e6fa653b275fa622f8b008087053c8ad43 /doc | |
| parent | bb2c5a3684a5b7240c7104a095077947029319b7 (diff) | |
doc: Add Nixpkgs config options reference
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doc-support/default.nix | 9 | ||||
| -rw-r--r-- | doc/using/configuration.chapter.md | 8 |
2 files changed, 17 insertions, 0 deletions
diff --git a/doc/doc-support/default.nix b/doc/doc-support/default.nix index 53990b677196..7c00195ab390 100644 --- a/doc/doc-support/default.nix +++ b/doc/doc-support/default.nix @@ -23,6 +23,14 @@ let <xsl:import href="${./parameters.xml}"/> </xsl:stylesheet> ''; + + # NB: This file describes the Nixpkgs manual, which happens to use module + # docs infra originally developed for NixOS. + optionsDoc = pkgs.nixosOptionsDoc { + inherit (pkgs.lib.evalModules { modules = [ ../../pkgs/top-level/config.nix ]; }) options; + documentType = "none"; + }; + in pkgs.runCommand "doc-support" {} '' mkdir result @@ -30,6 +38,7 @@ in pkgs.runCommand "doc-support" {} cd result ln -s ${locationsXml} ./function-locations.xml ln -s ${functionDocs} ./function-docs + ln -s ${optionsDoc.optionsDocBook} ./config-options.docbook.xml ln -s ${pkgs.docbook5}/xml/rng/docbook/docbook.rng ./docbook.rng ln -s ${pkgs.docbook_xsl_ns}/xml/xsl ./xsl diff --git a/doc/using/configuration.chapter.md b/doc/using/configuration.chapter.md index 932b24237c02..842450ebf47f 100644 --- a/doc/using/configuration.chapter.md +++ b/doc/using/configuration.chapter.md @@ -164,6 +164,14 @@ There are several ways to tweak how Nix handles a package which has been marked Note that `permittedInsecurePackages` is only checked if `allowInsecurePredicate` is not specified. +### `config` Options Reference + +The following attributes can be passed in [`config`](#chap-packageconfig). + +```{=docbook} +<include xmlns="http://www.w3.org/2001/XInclude" href="../doc-support/result/config-options.docbook.xml"/> +``` + ## Modify packages via `packageOverrides` {#sec-modify-via-packageOverrides} You can define a function called `packageOverrides` in your local `~/.config/nixpkgs/config.nix` to override Nix packages. It must be a function that takes pkgs as an argument and returns a modified set of packages. |