summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLéo Gaspard <leo@gaspard.io>2018-11-11 22:55:23 +0900
committerLéo Gaspard <leo@gaspard.io>2018-11-11 23:11:46 +0900
commit2986ce16a8012e90f0066b7bc9ccea1543644a4b (patch)
tree03ede8b20887000ec655676be8e67e566f5802c2 /doc
parentcae5598611e74dfebf98e67803d4935f95888500 (diff)
downloadnixpkgs-2986ce16a8012e90f0066b7bc9ccea1543644a4b.tar
nixpkgs-2986ce16a8012e90f0066b7bc9ccea1543644a4b.tar.gz
nixpkgs-2986ce16a8012e90f0066b7bc9ccea1543644a4b.tar.bz2
nixpkgs-2986ce16a8012e90f0066b7bc9ccea1543644a4b.tar.lz
nixpkgs-2986ce16a8012e90f0066b7bc9ccea1543644a4b.tar.xz
nixpkgs-2986ce16a8012e90f0066b7bc9ccea1543644a4b.tar.zst
nixpkgs-2986ce16a8012e90f0066b7bc9ccea1543644a4b.zip
meta.tests: rename into passthru.tests
Nix currently rejects derivations in `meta` values. This works around
that limitation by using `passthru` instead.

Closes https://github.com/NixOS/nixpkgs/issues/50230
Diffstat (limited to 'doc')
-rw-r--r--doc/meta.xml13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/meta.xml b/doc/meta.xml
index a7e467a78cb..3abfe016d70 100644
--- a/doc/meta.xml
+++ b/doc/meta.xml
@@ -255,6 +255,17 @@ meta.platforms = stdenv.lib.platforms.linux;
      <varname>tests</varname>
     </term>
     <listitem>
+     <warning>
+      <para>
+       This attribute is special in that it is not actually under the
+       <literal>meta</literal> attribute set but rather under the
+       <literal>passthru</literal> attribute set. This is due to a current
+       limitation of Nix, and will change as soon as Nixpkgs will be able to
+       depend on a new enough version of Nix. See
+       <link xlink:href="https://github.com/NixOS/nix/issues/2532">the relevant
+       issue</link> for more details.
+      </para>
+     </warning>
      <para>
       An attribute set with as values tests. A test is a derivation, which
       builds successfully when the test passes, and fails to build otherwise. A
@@ -269,7 +280,7 @@ meta.platforms = stdenv.lib.platforms.linux;
 { /* ... */, nixosTests }:
 {
   # ...
-  meta.tests = {
+  passthru.tests = {
     basic-functionality-and-dovecot-integration = nixosTests.opensmtpd;
   };
 }