about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorFrederik Rietdijk <fridh@fridh.nl>2018-11-12 18:59:08 +0100
committerFrederik Rietdijk <fridh@fridh.nl>2018-11-12 18:59:08 +0100
commitdaf3297cb46f73522d021e22c4dc7e0eb6920333 (patch)
tree75d39f6f6933dafd9ac36e4082526075906271c1 /doc
parent917400bcffd3a4179c4789a91857a5f1420081dd (diff)
parent968b20e2c7405f27830b6f10a8cac975e965dc94 (diff)
downloadnixlib-daf3297cb46f73522d021e22c4dc7e0eb6920333.tar
nixlib-daf3297cb46f73522d021e22c4dc7e0eb6920333.tar.gz
nixlib-daf3297cb46f73522d021e22c4dc7e0eb6920333.tar.bz2
nixlib-daf3297cb46f73522d021e22c4dc7e0eb6920333.tar.lz
nixlib-daf3297cb46f73522d021e22c4dc7e0eb6920333.tar.xz
nixlib-daf3297cb46f73522d021e22c4dc7e0eb6920333.tar.zst
nixlib-daf3297cb46f73522d021e22c4dc7e0eb6920333.zip
Merge master into staging-next
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/ocaml.xml8
-rw-r--r--doc/meta.xml29
2 files changed, 17 insertions, 20 deletions
diff --git a/doc/languages-frameworks/ocaml.xml b/doc/languages-frameworks/ocaml.xml
index d1c29c72f726..ea0770616802 100644
--- a/doc/languages-frameworks/ocaml.xml
+++ b/doc/languages-frameworks/ocaml.xml
@@ -67,9 +67,9 @@ buildDunePackage rec {
 
  <para>
    Here is a second example, this time using a source archive generated with
-   <literal>dune-release</literal>. The <literal>unpackCmd</literal>
-   redefinition is necessary to be able to unpack the kind of tarball that
-   <literal>dune-release</literal> generates. This library does not depend
+   <literal>dune-release</literal>. It is a good idea to use this archive when
+   it is available as it will usually contain substituted variables such as a
+   <literal>%%VERSION%%</literal> field. This library does not depend
    on any other OCaml library and no tests are run after building it.
  </para>
 
@@ -87,8 +87,6 @@ buildDunePackage rec {
     sha256 = "1msg3vycd3k8qqj61sc23qks541cxpb97vrnrvrhjnqxsqnh6ygq";
   };
 
-  unpackCmd = "tar xjf $src";
-
   meta = with stdenv.lib; {
     homepage = https://github.com/flowtype/ocaml-wtf8;
     description = "WTF-8 is a superset of UTF-8 that allows unpaired surrogates.";
diff --git a/doc/meta.xml b/doc/meta.xml
index 51c7b2dfc88f..3abfe016d708 100644
--- a/doc/meta.xml
+++ b/doc/meta.xml
@@ -255,12 +255,22 @@ 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
-      derivation that is a test requires some <literal>meta</literal> elements
-      to be defined: <literal>needsVMSupport</literal> (automatically filled-in
-      for NixOS tests) and <literal>timeout</literal>.
+      derivation that is a test needs to have <literal>meta.timeout</literal>
+      defined.
      </para>
      <para>
       The NixOS tests are available as <literal>nixosTests</literal> in
@@ -270,7 +280,7 @@ meta.platforms = stdenv.lib.platforms.linux;
 { /* ... */, nixosTests }:
 {
   # ...
-  meta.tests = {
+  passthru.tests = {
     basic-functionality-and-dovecot-integration = nixosTests.opensmtpd;
   };
 }
@@ -296,17 +306,6 @@ meta.platforms = stdenv.lib.platforms.linux;
    </varlistentry>
    <varlistentry>
     <term>
-     <varname>needsVMSupport</varname>
-    </term>
-    <listitem>
-     <para>
-      A boolan that states whether the derivation requires build-time support
-      for Virtual Machine to build successfully.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
      <varname>hydraPlatforms</varname>
     </term>
     <listitem>