summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLuca Bruno <lethalman88@gmail.com>2015-05-18 12:55:02 +0200
committerLuca Bruno <lethalman88@gmail.com>2015-05-18 12:55:02 +0200
commitd511369fcc0c524457ff01379afda96b3fe0f360 (patch)
treec2a97522fe0308852c1403264186b3494ad49088 /doc
parent1a3de464170dc38784fb2c5620003f89bcd0ce9c (diff)
downloadnixpkgs-d511369fcc0c524457ff01379afda96b3fe0f360.tar
nixpkgs-d511369fcc0c524457ff01379afda96b3fe0f360.tar.gz
nixpkgs-d511369fcc0c524457ff01379afda96b3fe0f360.tar.bz2
nixpkgs-d511369fcc0c524457ff01379afda96b3fe0f360.tar.lz
nixpkgs-d511369fcc0c524457ff01379afda96b3fe0f360.tar.xz
nixpkgs-d511369fcc0c524457ff01379afda96b3fe0f360.tar.zst
nixpkgs-d511369fcc0c524457ff01379afda96b3fe0f360.zip
go: document disabled flag
Diffstat (limited to 'doc')
-rw-r--r--doc/language-support.xml13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/language-support.xml b/doc/language-support.xml
index 5942fe01e2e..da709b34a94 100644
--- a/doc/language-support.xml
+++ b/doc/language-support.xml
@@ -674,6 +674,7 @@ net = buildGoPackage rec {
   goPackageAliases = [ "code.google.com/p/go.net" ]; <co xml:id='ex-buildGoPackage-3' />
   propagatedBuildInputs = [ goPackages.text ]; <co xml:id='ex-buildGoPackage-4' />
   buildFlags = "--tags release"; <co xml:id='ex-buildGoPackage-5' />
+  disabled = isGo13;<co xml:id='ex-buildGoPackage-6' />
 };
 </programlisting>
 </example>
@@ -731,6 +732,18 @@ the following arguments are of special significance to the function:
     </para>
   </callout>
 
+  <callout arearefs='ex-buildGoPackage-6'>
+    <para>
+      If <varname>disabled</varname> is <literal>true</literal>,
+      nix will refuse to build this package.
+    </para>
+    <para>
+      In this example the package will not be built for go 1.3. The <literal>isGo13</literal>
+      is an utility function that returns <literal>true</literal> if go used to build the
+      package has version 1.3.x.
+    </para>
+  </callout>
+
 </calloutlist>
 
 </para>