diff options
| author | Edward Tjörnhammar <ed@cflags.cc> | 2015-04-30 13:46:31 +0200 |
|---|---|---|
| committer | Edward Tjörnhammar <ed@cflags.cc> | 2015-06-28 12:42:43 +0200 |
| commit | c45b5aba92cc6b7d7e3602335c97a084f2ed0144 (patch) | |
| tree | 9f01575a68bf3227f3868e3b0c45bfe9fd63fe43 /doc/meta.xml | |
| parent | da7355e562d79d23b10f32766b69e1b05eda5d0d (diff) | |
| download | nixlib-c45b5aba92cc6b7d7e3602335c97a084f2ed0144.tar nixlib-c45b5aba92cc6b7d7e3602335c97a084f2ed0144.tar.gz nixlib-c45b5aba92cc6b7d7e3602335c97a084f2ed0144.tar.bz2 nixlib-c45b5aba92cc6b7d7e3602335c97a084f2ed0144.tar.lz nixlib-c45b5aba92cc6b7d7e3602335c97a084f2ed0144.tar.xz nixlib-c45b5aba92cc6b7d7e3602335c97a084f2ed0144.tar.zst nixlib-c45b5aba92cc6b7d7e3602335c97a084f2ed0144.zip | |
Document the different license base cases
Diffstat (limited to 'doc/meta.xml')
| -rw-r--r-- | doc/meta.xml | 39 |
1 files changed, 33 insertions, 6 deletions
diff --git a/doc/meta.xml b/doc/meta.xml index 14a01ccb3c07..b36f3915ec19 100644 --- a/doc/meta.xml +++ b/doc/meta.xml @@ -138,12 +138,39 @@ meta-attributes</title> <varlistentry> <term><varname>license</varname></term> - <listitem><para>The license for the package. One from the - attribute set defined in <link - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> - <filename>nixpkgs/lib/licenses.nix</filename></link>. Example: - <literal>stdenv.lib.licenses.gpl3</literal>. For details, see - <xref linkend='sec-meta-license'/>.</para></listitem> + <listitem> + <para> + The license, or licenses, for the package. One from the attribute set + defined in <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> + <filename>nixpkgs/lib/licenses.nix</filename></link>. At this moment + using both a list of licenses and a single license is valid. If the + license field is in the form of a list representation, then it means + that parts of the package are licensed differently. Each license + should preferably be referenced by their attribute. The non-list + attribute value can also be a space delimited string representation of + the contained attribute shortNames or spdxIds. The following are all valid + examples: + <itemizedlist> + <listitem><para>Single license referenced by attribute (preferred) + <literal>stdenv.lib.licenses.gpl3</literal>. + </para></listitem> + <listitem><para>Single license referenced by its attribute shortName (frowned upon) + <literal>"gpl3"</literal>. + </para></listitem> + <listitem><para>Single license referenced by its attribute spdxId (frowned upon) + <literal>"GPL-3.0"</literal>. + </para></listitem> + <listitem><para>Multiple licenses referenced by attribute (preferred) + <literal>with stdenv.lib.licenses; [ asl20 free ofl ]</literal>. + </para></listitem> + <listitem><para>Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon) + <literal>"asl20 free ofl"</literal>. + </para></listitem> + </itemizedlist> + For details, see <xref linkend='sec-meta-license'/>. + </para> + </listitem> </varlistentry> <varlistentry> |