buildPythonPacakage: update docs
This commit is contained in:
parent
925300726d
commit
2e605199a7
@ -196,12 +196,12 @@ you need it.</para>
|
|||||||
|
|
||||||
<para>
|
<para>
|
||||||
Currently supported interpreters are <varname>python26</varname>, <varname>python27</varname>,
|
Currently supported interpreters are <varname>python26</varname>, <varname>python27</varname>,
|
||||||
<varname>python32</varname>, <varname>python33</varname>, <varname>python34</varname>
|
<varname>python33</varname>, <varname>python34</varname>, <varname>python35</varname>
|
||||||
and <varname>pypy</varname>.
|
and <varname>pypy</varname>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
<varname>python</varname> is an alias of <varname>python27</varname> and <varname>python3</varname> is an alias of <varname>python34</varname>.
|
<varname>python</varname> is an alias to <varname>python27</varname> and <varname>python3</varname> is an alias to <varname>python34</varname>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
@ -231,7 +231,7 @@ are provided with all modules included.</para>
|
|||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
All packages depending on any Python interpreter get appended <varname>$out/${python.libPrefix}/site-packages</varname>
|
All packages depending on any Python interpreter get appended <varname>$out/${python.sitePackages}</varname>
|
||||||
to <literal>$PYTHONPATH</literal> if such directory exists.
|
to <literal>$PYTHONPATH</literal> if such directory exists.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@ -306,7 +306,7 @@ twisted = buildPythonPackage {
|
|||||||
Most of Python packages that use <varname>buildPythonPackage</varname> are defined
|
Most of Python packages that use <varname>buildPythonPackage</varname> are defined
|
||||||
in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/python-packages.nix"><filename>pkgs/top-level/python-packages.nix</filename></link>
|
in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/python-packages.nix"><filename>pkgs/top-level/python-packages.nix</filename></link>
|
||||||
and generated for each python interpreter separately into attribute sets <varname>python26Packages</varname>,
|
and generated for each python interpreter separately into attribute sets <varname>python26Packages</varname>,
|
||||||
<varname>python27Packages</varname>, <varname>python32Packages</varname>, <varname>python33Packages</varname>,
|
<varname>python27Packages</varname>, <varname>python35Packages</varname>, <varname>python33Packages</varname>,
|
||||||
<varname>python34Packages</varname> and <varname>pypyPackages</varname>.
|
<varname>python34Packages</varname> and <varname>pypyPackages</varname>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@ -314,20 +314,14 @@ twisted = buildPythonPackage {
|
|||||||
<function>buildPythonPackage</function> mainly does four things:
|
<function>buildPythonPackage</function> mainly does four things:
|
||||||
|
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem><para>
|
|
||||||
In the <varname>configurePhase</varname>, it patches
|
|
||||||
<literal>setup.py</literal> to always include setuptools before
|
|
||||||
distutils for monkeypatching machinery to take place.
|
|
||||||
</para></listitem>
|
|
||||||
|
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
In the <varname>buildPhase</varname>, it calls
|
In the <varname>buildPhase</varname>, it calls
|
||||||
<literal>${python.interpreter} setup.py build ...</literal>
|
<literal>${python.interpreter} setup.py bdist_wheel</literal> to build a wheel binary zipfile.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
|
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
In the <varname>installPhase</varname>, it calls
|
In the <varname>installPhase</varname>, it installs the wheel file using
|
||||||
<literal>${python.interpreter} setup.py install ...</literal>
|
<literal>pip install *.whl</literal>.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
|
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
@ -336,11 +330,15 @@ twisted = buildPythonPackage {
|
|||||||
directory to include <literal>$PYTHONPATH</literal> and <literal>$PATH</literal>
|
directory to include <literal>$PYTHONPATH</literal> and <literal>$PATH</literal>
|
||||||
environment variables.
|
environment variables.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
|
|
||||||
|
<listitem><para>
|
||||||
|
In the <varname>installCheck/varname> phase, <literal>${python.interpreter} setup.py test</literal>
|
||||||
|
is ran.
|
||||||
|
</para></listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>By default <varname>doCheck = true</varname> is set and tests are run with
|
<para>By default <varname>doCheck = true</varname> is set</para>
|
||||||
<literal>${python.interpreter} setup.py test</literal> command in <varname>checkPhase</varname>.</para>
|
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
As in Perl, dependencies on other Python packages can be specified in the
|
As in Perl, dependencies on other Python packages can be specified in the
|
||||||
@ -385,7 +383,7 @@ twisted = buildPythonPackage {
|
|||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>setupPyBuildFlags</varname></term>
|
<term><varname>setupPyBuildFlags</varname></term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
List of flags passed to <command>setup.py build</command> command.
|
List of flags passed to <command>setup.py build_ext</command> command.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
@ -393,7 +391,7 @@ twisted = buildPythonPackage {
|
|||||||
<term><varname>pythonPath</varname></term>
|
<term><varname>pythonPath</varname></term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
List of packages to be added into <literal>$PYTHONPATH</literal>.
|
List of packages to be added into <literal>$PYTHONPATH</literal>.
|
||||||
Packages in <varname>pythonPath</varname> are not propagated into user environment
|
Packages in <varname>pythonPath</varname> are not propagated
|
||||||
(contrary to <varname>propagatedBuildInputs</varname>).
|
(contrary to <varname>propagatedBuildInputs</varname>).
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
@ -412,15 +410,6 @@ twisted = buildPythonPackage {
|
|||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term><varname>distutilsExtraCfg</varname></term>
|
|
||||||
<listitem><para>
|
|
||||||
Extra lines passed to <varname>[easy_install]</varname> section of
|
|
||||||
<filename>distutils.cfg</filename> (acts as global setup.cfg
|
|
||||||
configuration).
|
|
||||||
</para></listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>makeWrapperArgs</varname></term>
|
<term><varname>makeWrapperArgs</varname></term>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user