doc/meta.xml: fix github links, clarify licensing section
This commit is contained in:
parent
cb8f8bdbff
commit
5cc2a142b0
17
doc/meta.xml
17
doc/meta.xml
|
@ -121,10 +121,11 @@ interpretation:</para>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>license</varname></term>
|
<term><varname>license</varname></term>
|
||||||
<listitem><para>The license for the package. One from attribute set defined in
|
<listitem><para>The license for the package. One from attribute set defined in
|
||||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/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>.
|
||||||
Example:
|
Example:
|
||||||
<literal>stdenv.lib.licenses.gpl3</literal>.</para></listitem>
|
<literal>stdenv.lib.licenses.gpl3</literal>.</para></listitem>
|
||||||
|
See details in <xref linkend='sec-meta-license'/>,
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
|
@ -133,7 +134,7 @@ interpretation:</para>
|
||||||
maintainers of this Nix expression. If
|
maintainers of this Nix expression. If
|
||||||
you would like to be a maintainer of a package, you may want to add
|
you would like to be a maintainer of a package, you may want to add
|
||||||
yourself to <link
|
yourself to <link
|
||||||
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/lib/maintainers.nix"><filename>nixpkgs/lib/maintainers.nix</filename></link>
|
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/maintainers.nix"><filename>nixpkgs/lib/maintainers.nix</filename></link>
|
||||||
and write something like <literal>[ stdenv.lib.maintainers.alice
|
and write something like <literal>[ stdenv.lib.maintainers.alice
|
||||||
stdenv.lib.maintainers.bob ]</literal>.</para></listitem>
|
stdenv.lib.maintainers.bob ]</literal>.</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
@ -160,7 +161,7 @@ meta.platforms = stdenv.lib.platforms.linux;
|
||||||
</programlisting>
|
</programlisting>
|
||||||
|
|
||||||
Attribute Set <varname>stdenv.lib.platforms</varname> in
|
Attribute Set <varname>stdenv.lib.platforms</varname> in
|
||||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/lib/platforms.nix">
|
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/platforms.nix">
|
||||||
<filename>nixpkgs/lib/platforms.nix</filename></link> defines various common
|
<filename>nixpkgs/lib/platforms.nix</filename></link> defines various common
|
||||||
lists of platforms types.
|
lists of platforms types.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
|
@ -202,9 +203,15 @@ meta.hydraPlatforms = [];
|
||||||
|
|
||||||
<section xml:id="sec-meta-license"><title>Licenses</title>
|
<section xml:id="sec-meta-license"><title>Licenses</title>
|
||||||
|
|
||||||
<para>The <varname>meta.license</varname> attribute could be one of the
|
<para>The <varname>meta.license</varname> attribute should preferrably contain
|
||||||
following:
|
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.
|
||||||
|
|
||||||
|
A few generic options are available, although it's typically better
|
||||||
|
to indicate the specific license:
|
||||||
<variablelist>
|
<variablelist>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
|
|
Loading…
Reference in a new issue