public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixpkgs manual: Fix license strings docs

Browse Source 
The wrong usage of unfree-redistributable fixed in
ea242619fb 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.
This commit is contained in:
Franz Pletz 2016-02-24 01:37:40 +01:00
parent ea242619fb
commit 7f7ebe5bf6
1 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/meta.xml
View File

@ -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"> <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix">
<filename>nixpkgs/lib/licenses.nix</filename></link>, <filename>nixpkgs/lib/licenses.nix</filename></link>,
or in-place license description of the same format if the license is 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> <variablelist>
<varlistentry> <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 <listitem><para>Catch-all for free software licenses not listed
above.</para></listitem> above.</para></listitem>
</varlistentry> </varlistentry>
<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 <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 <emphasis>output</emphasis> of the derivation. This means that
the package can be included in the Nixpkgs the package can be included in the Nixpkgs
channel.</para> channel.</para>
<para>Sometimes proprietary software can only be redistributed <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 original binaries; otherwise we’re breaking the license. For
instance, the NVIDIA X11 drivers can be redistributed unmodified, instance, the NVIDIA X11 drivers can be redistributed unmodified,
but our builder applies <command>patchelf</command> to make them 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> cannot be included in the Nixpkgs channel.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>unfree</varname></term> <term><varname>stdenv.lib.licenses.unfree</varname>,
<listitem><para>Unfree package that cannot be redistributed. You <varname>"unfree"</varname></term>
<listitem><para>Unfree package that cannot be redistributed. You
can build it yourself, but you cannot redistribute the output of 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> channel.</para></listitem>
</varlistentry> </varlistentry>
<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 <listitem><para>This package supplies unfree, redistributable
firmware. This is a separate value from firmware. This is a separate value from
<varname>unfree-redistributable</varname> because not everybody <varname>unfree-redistributable</varname> because not everybody