about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFranz Pletz <fpletz@fnordicwalking.de>2016-02-24 01:37:40 +0100
committerFranz Pletz <fpletz@fnordicwalking.de>2016-02-24 01:48:02 +0100
commit7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750 (patch)
treed96582ed8381b54764010b6b67343105125e3d76
parentea242619fb0028f830238a0fa1b19277d14508ff (diff)
downloadnixlib-7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750.tar
nixlib-7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750.tar.gz
nixlib-7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750.tar.bz2
nixlib-7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750.tar.lz
nixlib-7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750.tar.xz
nixlib-7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750.tar.zst
nixlib-7f7ebe5bf6ecb6fcb3c5d603c8f2e5b927ad0750.zip
nixpkgs manual: Fix license strings docs
The wrong usage of unfree-redistributable fixed in
ea242619fb0028f830238a0fa1b19277d14508ff can be explaind by unclear
documention, specifically the section in the nixpkgs manual describing
generic licenses it is written to use attributes from `stdenv.lib.licenses`
but in the list the strings form was documented without quotation marks.

This confuses people because the package builds fine locally but failes
the tests on travis-ci.
-rw-r--r--doc/meta.xml33
1 files changed, 21 insertions, 12 deletions
diff --git a/doc/meta.xml b/doc/meta.xml
index 5266d83aea68..b1ffd0502b2b 100644
--- a/doc/meta.xml
+++ b/doc/meta.xml
@@ -258,45 +258,54 @@ a value from <varname>stdenv.lib.licenses</varname> defined in
 <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix">
 <filename>nixpkgs/lib/licenses.nix</filename></link>,
 or in-place license description of the same format if the license is
-unlikely to be useful in another expression.
+unlikely to be useful in another expression.</para>
+
+<para>Although it's typically better to indicate the specific license,
+a few generic options are available:
 
-A few generic options are available, although it's typically better
-to indicate the specific license:
 <variablelist>
 
   <varlistentry>
-    <term><varname>free</varname></term>
+    <term><varname>stdenv.lib.licenses.free</varname>,
+    <varname>"free"</varname></term>
+
     <listitem><para>Catch-all for free software licenses not listed
     above.</para></listitem>
   </varlistentry>
 
   <varlistentry>
-    <term><varname>unfree-redistributable</varname></term>
+    <term><varname>stdenv.lib.licenses.unfreeRedistributable</varname>,
+    <varname>"unfree-redistributable"</varname></term>
+
     <listitem><para>Unfree package that can be redistributed in binary
-    form.  That is, it’s legal to redistribute the
+    form. That is, it’s legal to redistribute the
     <emphasis>output</emphasis> of the derivation.  This means that
     the package can be included in the Nixpkgs
     channel.</para>
 
     <para>Sometimes proprietary software can only be redistributed
-    unmodified.  Make sure the builder doesn’t actually modify the
+    unmodified. Make sure the builder doesn’t actually modify the
     original binaries; otherwise we’re breaking the license.  For
     instance, the NVIDIA X11 drivers can be redistributed unmodified,
     but our builder applies <command>patchelf</command> to make them
-    work.  Thus, its license is <varname>unfree</varname> and it
+    work. Thus, its license is <varname>"unfree"</varname> and it
     cannot be included in the Nixpkgs channel.</para></listitem>
   </varlistentry>
 
   <varlistentry>
-    <term><varname>unfree</varname></term>
-    <listitem><para>Unfree package that cannot be redistributed.  You
+    <term><varname>stdenv.lib.licenses.unfree</varname>,
+    <varname>"unfree"</varname></term>
+
+    <listitem><para>Unfree package that cannot be redistributed. You
     can build it yourself, but you cannot redistribute the output of
-    the derivation.  Thus it cannot be included in the Nixpkgs
+    the derivation. Thus it cannot be included in the Nixpkgs
     channel.</para></listitem>
   </varlistentry>
 
   <varlistentry>
-    <term><varname>unfree-redistributable-firmware</varname></term>
+    <term><varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>,
+    <varname>"unfree-redistributable-firmware"</varname></term>
+
     <listitem><para>This package supplies unfree, redistributable
     firmware.  This is a separate value from
     <varname>unfree-redistributable</varname> because not everybody