Gentoo Development Guide

DISTUTILS.ECLASS

Section: portage (5)
Updated: Sep 2014
Index Return to Main Contents
 

NAME

distutils.eclass - Eclass for packages with build systems using Distutils  

DESCRIPTION

The distutils eclass defines phase functions for packages with build systems using Distutils.  

FUNCTIONS

distutils_src_unpack
The distutils src_unpack function. This function is exported.
distutils_src_prepare
The distutils src_prepare function. This function is exported.
distutils_src_compile
The distutils src_compile function. This function is exported. In ebuilds of packages supporting installation for multiple versions of Python, this function calls distutils_src_compile_pre_hook() and distutils_src_compile_post_hook(), if they are defined.
distutils_src_test
The distutils src_test function. This function is exported, when DISTUTILS_SRC_TEST variable is set. In ebuilds of packages supporting installation for multiple versions of Python, this function calls distutils_src_test_pre_hook() and distutils_src_test_post_hook(), if they are defined.
distutils_src_install
The distutils src_install function. This function is exported. In ebuilds of packages supporting installation for multiple versions of Python, this function calls distutils_src_install_pre_hook() and distutils_src_install_post_hook(), if they are defined. It also installs some standard documentation files (AUTHORS, Change*, CHANGELOG, CONTRIBUTORS, KNOWN_BUGS, MAINTAINERS, NEWS, README*, TODO).
distutils_pkg_postinst
The distutils pkg_postinst function. This function is exported. When PYTHON_MODNAME variable is set, then this function calls python_mod_optimize() with modules specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_optimize() with module, whose name is equal to name of current package, if this module exists.
distutils_pkg_postrm
The distutils pkg_postrm function. This function is exported. When PYTHON_MODNAME variable is set, then this function calls python_mod_cleanup() with modules specified in PYTHON_MODNAME variable. Otherwise it calls python_mod_cleanup() with module, whose name is equal to name of current package, if this module exists.
distutils_get_intermediate_installation_image
Print path to intermediate installation image.

This function can be used only in distutils_src_install_pre_hook() and distutils_src_install_post_hook().

 

ECLASS VARIABLES

DISTUTILS_USE_SEPARATE_SOURCE_DIRECTORIES
Set this to use separate source directories for each enabled version of Python.
DISTUTILS_SETUP_FILES
Array of paths to setup files. Syntax:
  [current_working_directory|]path_to_setup_file
DISTUTILS_GLOBAL_OPTIONS
Array of global options passed to setup files. Syntax in EAPI <4:
  global_option Syntax in EAPI >=4:
  Python_ABI_pattern global_option
DISTUTILS_SRC_TEST
Type of test command used by distutils_src_test(). IUSE and DEPEND are automatically adjusted, unless DISTUTILS_DISABLE_TEST_DEPENDENCY is set. Valid values:
  setup.py
  nosetests
  py.test
  trial [arguments]
DISTUTILS_DISABLE_TEST_DEPENDENCY
Disable modification of IUSE and DEPEND caused by setting of DISTUTILS_SRC_TEST.
DOCS
Additional documentation files installed by distutils_src_install().
 

MAINTAINERS

Gentoo Python Project <python@gentoo.org>
 

REPORTING BUGS

Please report bugs via http://bugs.gentoo.org/  

FILES

/usr/portage/eclass/distutils.eclass  

SEE ALSO

ebuild(5)
http://sources.gentoo.org/eclass/distutils.eclass?view=log


 

Index

NAME
DESCRIPTION
FUNCTIONS
ECLASS VARIABLES
MAINTAINERS
REPORTING BUGS
FILES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 03:25:02 GMT, September 03, 2014