summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2013-11-04 20:32:49 +0100
committerEelco Dolstra <eelco.dolstra@logicblox.com>2013-11-04 21:11:00 +0100
commit754704ea1884563beda72ddff2ab328e690278d0 (patch)
tree79a82650866e2efa46b1b1b5e8b83eb3c259f7cb /doc
parent01087750bacd329543c69876c0a7faac395098d3 (diff)
downloadnixpkgs-754704ea1884563beda72ddff2ab328e690278d0.tar
nixpkgs-754704ea1884563beda72ddff2ab328e690278d0.tar.gz
nixpkgs-754704ea1884563beda72ddff2ab328e690278d0.tar.bz2
nixpkgs-754704ea1884563beda72ddff2ab328e690278d0.tar.lz
nixpkgs-754704ea1884563beda72ddff2ab328e690278d0.tar.xz
nixpkgs-754704ea1884563beda72ddff2ab328e690278d0.tar.zst
nixpkgs-754704ea1884563beda72ddff2ab328e690278d0.zip
Allow packages to be marked as "broken" by setting meta.broken
The effect is that they won't show up in "nix-env -qa" anymore.
Diffstat (limited to 'doc')
-rw-r--r--doc/meta.xml9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/meta.xml b/doc/meta.xml
index 09252410d80..df84915cc09 100644
--- a/doc/meta.xml
+++ b/doc/meta.xml
@@ -118,6 +118,15 @@ interpretation:</para>
     package).</para></listitem>
   </varlistentry>
 
+  <varlistentry>
+    <term><varname>broken</varname></term>
+    <listitem><para>If set to <literal>true</literal>, the package is
+    marked as “broken”, meaning that it won’t show up in
+    <literal>nix-env -qa</literal>, and cannot be built or installed.
+    Sush packages should be removed from Nixpkgs eventually unless
+    they are fixed.</para></listitem>
+  </varlistentry>
+
 </variablelist>