diff options
Diffstat (limited to 'eclass/distutils-r1.eclass')
| -rw-r--r-- | eclass/distutils-r1.eclass | 42 |
1 files changed, 37 insertions, 5 deletions
diff --git a/eclass/distutils-r1.eclass b/eclass/distutils-r1.eclass index 385274e5713d..093f79c3cb5e 100644 --- a/eclass/distutils-r1.eclass +++ b/eclass/distutils-r1.eclass @@ -1,6 +1,6 @@ # Copyright 1999-2012 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 -# $Header: /var/cvsroot/gentoo-x86/eclass/distutils-r1.eclass,v 1.4 2012/10/19 19:55:46 mgorny Exp $ +# $Header: /var/cvsroot/gentoo-x86/eclass/distutils-r1.eclass,v 1.5 2012/10/23 20:58:05 mgorny Exp $ # @ECLASS: distutils-r1 # @MAINTAINER: @@ -34,7 +34,12 @@ # functions, you should consider calling the defaults (and especially # distutils-r1_python_prepare_all). # -# Please note that distutils-r1 sets RDEPEND and DEPEND for you. +# Please note that distutils-r1 sets RDEPEND and DEPEND unconditionally +# for you. +# +# Also, please note that distutils-r1 will always inherit python-r1 +# as well. Thus, all the variables defined and documented there are +# relevant to the packages using distutils-r1. case "${EAPI}" in 0|1|2|3) @@ -55,12 +60,32 @@ RDEPEND="${PYTHON_DEPS} dev-python/python-exec" DEPEND=${PYTHON_DEPS} +# @ECLASS-VARIABLE: PATCHES +# @DEFAULT_UNSET +# @DESCRIPTION: +# An array containing patches to be applied to the sources before +# copying them. +# +# If unset, no custom patches will be applied. +# +# Please note, however, that at some point the eclass may apply +# additional distutils patches/quirks independently of this variable. +# +# Example: +# @CODE +# PATCHES=( "${FILESDIR}"/${P}-make-gentoo-happy.patch ) +# @CODE + # @ECLASS-VARIABLE: DOCS # @DEFAULT_UNSET # @DESCRIPTION: -# Array containing documents installed using dodoc. +# An array containing documents installed using dodoc. The files listed +# there must exist in the directory from which +# distutils-r1_python_install_all() is run (${S} by default). # -# If unset, the default filename list (from PMS) will be used. +# If unset, the function will instead look up files matching default +# filename pattern list (from the Package Manager Specification), +# and install those found. # # Example: # @CODE @@ -70,7 +95,11 @@ DEPEND=${PYTHON_DEPS} # @ECLASS-VARIABLE: HTML_DOCS # @DEFAULT_UNSET # @DESCRIPTION: -# Array containing documents installed using dohtml. +# An array containing documents installed using dohtml. The files +# and directories listed there must exist in the directory from which +# distutils-r1_python_install_all() is run (${S} by default). +# +# If unset, no HTML docs will be installed. # # Example: # @CODE @@ -82,6 +111,9 @@ DEPEND=${PYTHON_DEPS} # The default python_prepare_all(). It applies the patches from PATCHES # array, then user patches and finally calls python_copy_sources to # create copies of resulting sources for each Python implementation. +# +# At some point in the future, it may also apply eclass-specific +# distutils patches and/or quirks. distutils-r1_python_prepare_all() { debug-print-function ${FUNCNAME} "${@}" |