about summary refs log tree commit diff
path: root/nixpkgs/doc
diff options
context:
space:
mode:
authorAlyssa Ross <hi@alyssa.is>2021-02-16 18:32:21 +0000
committerAlyssa Ross <hi@alyssa.is>2021-02-16 18:32:21 +0000
commit9becdcc5df71b47a5da84ad670e9a7eae9e0c65a (patch)
tree2ddf0335eb393f89501e3753b50c3f7ab0552d12 /nixpkgs/doc
parent49f2a77ac9abc88c253f68952eda26557fc3b555 (diff)
parentff96a0fa5635770390b184ae74debea75c3fd534 (diff)
downloadnixlib-9becdcc5df71b47a5da84ad670e9a7eae9e0c65a.tar
nixlib-9becdcc5df71b47a5da84ad670e9a7eae9e0c65a.tar.gz
nixlib-9becdcc5df71b47a5da84ad670e9a7eae9e0c65a.tar.bz2
nixlib-9becdcc5df71b47a5da84ad670e9a7eae9e0c65a.tar.lz
nixlib-9becdcc5df71b47a5da84ad670e9a7eae9e0c65a.tar.xz
nixlib-9becdcc5df71b47a5da84ad670e9a7eae9e0c65a.tar.zst
nixlib-9becdcc5df71b47a5da84ad670e9a7eae9e0c65a.zip
nixpkgs: merge nixos-unstable
Diffstat (limited to 'nixpkgs/doc')
-rw-r--r--nixpkgs/doc/builders/packages/elm.section.md11
-rw-r--r--nixpkgs/doc/builders/packages/elm.xml17
-rw-r--r--nixpkgs/doc/builders/packages/index.xml2
-rw-r--r--nixpkgs/doc/contributing/contributing-to-documentation.xml2
-rw-r--r--nixpkgs/doc/default.nix2
-rw-r--r--nixpkgs/doc/functions/library/asserts.xml2
-rw-r--r--nixpkgs/doc/functions/library/attrsets.xml39
-rw-r--r--nixpkgs/doc/languages-frameworks/agda.section.md2
-rw-r--r--nixpkgs/doc/languages-frameworks/python.section.md4
-rw-r--r--nixpkgs/doc/stdenv/meta.xml30
-rw-r--r--nixpkgs/doc/using/configuration.xml4
-rw-r--r--nixpkgs/doc/using/overlays.xml5
12 files changed, 79 insertions, 41 deletions
diff --git a/nixpkgs/doc/builders/packages/elm.section.md b/nixpkgs/doc/builders/packages/elm.section.md
new file mode 100644
index 000000000000..53087c0e9ded
--- /dev/null
+++ b/nixpkgs/doc/builders/packages/elm.section.md
@@ -0,0 +1,11 @@
+# Elm {#sec-elm}
+
+To start a development environment do
+
+```ShellSession
+nix-shell -p elmPackages.elm elmPackages.elm-format
+```
+
+To update the Elm compiler, see <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>.
+
+To package Elm applications, [read about elm2nix](https://github.com/hercules-ci/elm2nix#elm2nix).
diff --git a/nixpkgs/doc/builders/packages/elm.xml b/nixpkgs/doc/builders/packages/elm.xml
deleted file mode 100644
index a067f6c7c70e..000000000000
--- a/nixpkgs/doc/builders/packages/elm.xml
+++ /dev/null
@@ -1,17 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xml:id="sec-elm">
- <title>Elm</title>
-
- <para>
-  To start a development environment do <command>nix-shell -p elmPackages.elm elmPackages.elm-format</command>
- </para>
-
- <para>
-  To update Elm compiler, see <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>.
- </para>
-
- <para>
-  To package Elm applications, <link xlink:href="https://github.com/hercules-ci/elm2nix#elm2nix">read about elm2nix</link>.
- </para>
-</section>
diff --git a/nixpkgs/doc/builders/packages/index.xml b/nixpkgs/doc/builders/packages/index.xml
index ab335e24ff99..e4f8a1d3120e 100644
--- a/nixpkgs/doc/builders/packages/index.xml
+++ b/nixpkgs/doc/builders/packages/index.xml
@@ -8,7 +8,7 @@
  <xi:include href="citrix.xml" />
  <xi:include href="dlib.xml" />
  <xi:include href="eclipse.xml" />
- <xi:include href="elm.xml" />
+ <xi:include href="elm.section.xml" />
  <xi:include href="emacs.section.xml" />
  <xi:include href="firefox.section.xml" />
  <xi:include href="fish.section.xml" />
diff --git a/nixpkgs/doc/contributing/contributing-to-documentation.xml b/nixpkgs/doc/contributing/contributing-to-documentation.xml
index b0266043775f..132fa3816e37 100644
--- a/nixpkgs/doc/contributing/contributing-to-documentation.xml
+++ b/nixpkgs/doc/contributing/contributing-to-documentation.xml
@@ -12,7 +12,7 @@ xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> sub
 <screen>
 <prompt>$ </prompt>cd /path/to/nixpkgs/doc
 <prompt>$ </prompt>nix-shell
-<prompt>[nix-shell]$ </prompt>make
+<prompt>[nix-shell]$ </prompt>make $makeFlags
 </screen>
  <para>
   If you experience problems, run <command>make debug</command> to help understand the docbook errors.
diff --git a/nixpkgs/doc/default.nix b/nixpkgs/doc/default.nix
index 543a3874170b..25389fa2da7e 100644
--- a/nixpkgs/doc/default.nix
+++ b/nixpkgs/doc/default.nix
@@ -15,7 +15,7 @@ in pkgs.stdenv.mkDerivation {
     xmlformat
   ];
 
-  src = ./.;
+  src = lib.cleanSource ./.;
 
   makeFlags = [
     "PANDOC_LUA_FILTERS_DIR=${pkgs.pandoc-lua-filters}/share/pandoc/filters"
diff --git a/nixpkgs/doc/functions/library/asserts.xml b/nixpkgs/doc/functions/library/asserts.xml
index 10891039e869..7c94222ef139 100644
--- a/nixpkgs/doc/functions/library/asserts.xml
+++ b/nixpkgs/doc/functions/library/asserts.xml
@@ -103,7 +103,7 @@ stderr> assert failed
    <title>Ensuring a user provided a possible value</title>
 <programlisting><![CDATA[
 let sslLibrary = "bearssl";
-in lib.asserts.assertOneOf "sslLibrary" sslLibrary [ "openssl" "bearssl" ];
+in lib.asserts.assertOneOf "sslLibrary" sslLibrary [ "openssl" "libressl" ];
 => false
 stderr> trace: sslLibrary must be one of "openssl", "libressl", but is: "bearssl"
         ]]></programlisting>
diff --git a/nixpkgs/doc/functions/library/attrsets.xml b/nixpkgs/doc/functions/library/attrsets.xml
index 3c5823c25891..7ef0d16624c8 100644
--- a/nixpkgs/doc/functions/library/attrsets.xml
+++ b/nixpkgs/doc/functions/library/attrsets.xml
@@ -1711,4 +1711,43 @@ recursiveUpdate
   </example>
  </section>
 
+ <section xml:id="function-library-lib.attrsets.cartesianProductOfSets">
+  <title><function>lib.attrsets.cartesianProductOfSets</function></title>
+
+  <subtitle><literal>cartesianProductOfSets :: AttrSet -> [ AttrSet ]</literal>
+  </subtitle>
+
+  <xi:include href="./locations.xml" xpointer="lib.attrsets.cartesianProductOfSets" />
+
+  <para>
+    Return the cartesian product of attribute set value combinations.
+  </para>
+
+  <variablelist>
+   <varlistentry>
+    <term>
+     <varname>set</varname>
+    </term>
+    <listitem>
+     <para>
+      An attribute set with attributes that carry lists of values.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+
+  <example xml:id="function-library-lib.attrsets.cartesianProductOfSets-example">
+   <title>Creating the cartesian product of a list of attribute values</title>
+<programlisting><![CDATA[
+cartesianProductOfSets { a = [ 1 2 ]; b = [ 10 20 ]; }
+=> [
+     { a = 1; b = 10; }
+     { a = 1; b = 20; }
+     { a = 2; b = 10; }
+     { a = 2; b = 20; }
+   ]
+]]></programlisting>
+  </example>
+ </section>
+
 </section>
diff --git a/nixpkgs/doc/languages-frameworks/agda.section.md b/nixpkgs/doc/languages-frameworks/agda.section.md
index 66b4a2083021..f57b194a7266 100644
--- a/nixpkgs/doc/languages-frameworks/agda.section.md
+++ b/nixpkgs/doc/languages-frameworks/agda.section.md
@@ -46,7 +46,7 @@ depend: standard-library
 More information can be found in the [official Agda documentation on library management](https://agda.readthedocs.io/en/v2.6.1/tools/package-system.html).
 
 ## Compiling Agda
-Agda modules can be compiled with the `--compile` flag. A version of `ghc` with `ieee` is made available to the Agda program via the `--with-compiler` flag.
+Agda modules can be compiled with the `--compile` flag. A version of `ghc` with `ieee754` is made available to the Agda program via the `--with-compiler` flag.
 This can be overridden by a different version of `ghc` as follows:
 
 ```
diff --git a/nixpkgs/doc/languages-frameworks/python.section.md b/nixpkgs/doc/languages-frameworks/python.section.md
index 2dea2cb1bcc9..71193ed0cc0b 100644
--- a/nixpkgs/doc/languages-frameworks/python.section.md
+++ b/nixpkgs/doc/languages-frameworks/python.section.md
@@ -610,6 +610,10 @@ Using the example above, the analagous pytestCheckHook usage would be:
     "download"
     "update"
   ];
+
+  disabledTestFiles = [
+    "tests/test_failing.py"
+  ];
 ```
 
 This is expecially useful when tests need to be conditionallydisabled,
diff --git a/nixpkgs/doc/stdenv/meta.xml b/nixpkgs/doc/stdenv/meta.xml
index 10802d1af59f..91ace0b9cc95 100644
--- a/nixpkgs/doc/stdenv/meta.xml
+++ b/nixpkgs/doc/stdenv/meta.xml
@@ -75,7 +75,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
   </para>
 
   <variablelist>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-description">
     <term>
      <varname>description</varname>
     </term>
@@ -94,7 +94,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-longDescription">
     <term>
      <varname>longDescription</varname>
     </term>
@@ -104,7 +104,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-branch">
     <term>
      <varname>branch</varname>
     </term>
@@ -114,7 +114,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-homepage">
     <term>
      <varname>homepage</varname>
     </term>
@@ -124,7 +124,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-downloadPage">
     <term>
      <varname>downloadPage</varname>
     </term>
@@ -134,7 +134,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-changelog">
     <term>
      <varname>changelog</varname>
     </term>
@@ -144,7 +144,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-license">
     <term>
      <varname>license</varname>
     </term>
@@ -183,7 +183,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-maintainers">
     <term>
      <varname>maintainers</varname>
     </term>
@@ -193,7 +193,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-priority">
     <term>
      <varname>priority</varname>
     </term>
@@ -203,7 +203,7 @@ hello-2.3  A program that produces a familiar, friendly greeting
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-platforms">
     <term>
      <varname>platforms</varname>
     </term>
@@ -217,7 +217,7 @@ meta.platforms = lib.platforms.linux;
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-tests">
     <term>
      <varname>tests</varname>
     </term>
@@ -244,7 +244,7 @@ meta.platforms = lib.platforms.linux;
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-timeout">
     <term>
      <varname>timeout</varname>
     </term>
@@ -254,7 +254,7 @@ meta.platforms = lib.platforms.linux;
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-hydraPlatforms">
     <term>
      <varname>hydraPlatforms</varname>
     </term>
@@ -268,7 +268,7 @@ meta.hydraPlatforms = [];
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-broken">
     <term>
      <varname>broken</varname>
     </term>
@@ -278,7 +278,7 @@ meta.hydraPlatforms = [];
      </para>
     </listitem>
    </varlistentry>
-   <varlistentry>
+   <varlistentry xml:id="var-meta-updateWalker">
     <term>
      <varname>updateWalker</varname>
     </term>
diff --git a/nixpkgs/doc/using/configuration.xml b/nixpkgs/doc/using/configuration.xml
index 1e1df867e08e..2cd2615f54ae 100644
--- a/nixpkgs/doc/using/configuration.xml
+++ b/nixpkgs/doc/using/configuration.xml
@@ -138,11 +138,11 @@
 </programlisting>
     </para>
     <para>
-     For a more useful example, try the following. This configuration only allows unfree packages named flash player and visual studio code:
+     For a more useful example, try the following. This configuration only allows unfree packages named roon-server and visual studio code:
 <programlisting>
 {
   allowUnfreePredicate = pkg: builtins.elem (lib.getName pkg) [
-    "flashplayer"
+    "roon-server"
     "vscode"
   ];
 }
diff --git a/nixpkgs/doc/using/overlays.xml b/nixpkgs/doc/using/overlays.xml
index 9ffbb4edd989..8bda235d43d8 100644
--- a/nixpkgs/doc/using/overlays.xml
+++ b/nixpkgs/doc/using/overlays.xml
@@ -236,10 +236,11 @@ self: super:
 {
   blas = super.blas.override {
     blasProvider = self.mkl;
-  }
+  };
+
   lapack = super.lapack.override {
     lapackProvider = self.mkl;
-  }
+  };
 }
 </programlisting>
      <para>