/[gentoo-x86]/eclass/base.eclass
Gentoo

Diff of /eclass/base.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.4 Revision 1.46
1# Copyright 1999-2000 Gentoo Technologies, Inc. 1# Copyright 1999-2008 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License, v2 or later 2# Distributed under the terms of the GNU General Public License v2
3# Author Dan Armak <danarmak@gentoo.org>
4# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.4 2001/09/29 12:35:38 danarmak Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.46 2010/01/20 19:21:19 scarabeus Exp $
5# The base eclass defines some default functions and variables. Nearly everything
6# else inherits from here.
7. /usr/portage/eclass/inherit.eclass || die
8inherit virtual || die
9ECLASS=base
10 4
11S=${WORKDIR}/${P} 5# @ECLASS: base.eclass
12DESCRIPTION="Based on the $ECLASS eclass" 6# @MAINTAINER:
7# QA Team <qa@gentoo.org>
8#
9# Original author Dan Armak <danarmak@gentoo.org>
10# @BLURB: The base eclass defines some default functions and variables.
11# @DESCRIPTION:
12# The base eclass defines some default functions and variables. Nearly
13# everything else inherits from here.
13 14
15inherit eutils
16
17BASE_EXPF="src_unpack src_compile src_install"
18case "${EAPI:-0}" in
19 2|3|4) BASE_EXPF+=" src_prepare src_configure" ;;
20 *) ;;
21esac
22
23EXPORT_FUNCTIONS ${BASE_EXPF}
24
25# @ECLASS-VARIABLE: DOCS
26# @DESCRIPTION:
27# Array containing documents passed to dodoc command.
28#
29# DOCS=( "${S}/doc/document.txt" "${S}/doc/doc_folder/" )
30
31# @ECLASS-VARIABLE: HTML_DOCS
32# @DESCRIPTION:
33# Array containing documents passed to dohtml command.
34#
35# HTML_DOCS=( "${S}/doc/document.html" "${S}/doc/html_folder/" )
36
37# @ECLASS-VARIABLE: PATCHES
38# @DESCRIPTION:
39# PATCHES array variable containing all various patches to be applied.
40# This variable is expected to be defined in global scope of ebuild.
41# Make sure to specify the full path. This variable is utilised in
42# src_unpack/src_prepare phase based on EAPI.
43#
44# NOTE: if using patches folders with special file suffixes you have to
45# define one additional variable EPATCH_SUFFIX="something"
46#
47# PATCHES=( "${FILESDIR}/mypatch.patch" "${FILESDIR}/patches_folder/" )
48
49
50# @FUNCTION: base_src_unpack
51# @DESCRIPTION:
52# The base src_unpack function, which is exported.
53# Calls also src_prepare with eapi older than 2.
14base_src_unpack() { 54base_src_unpack() {
15 55 debug-print-function $FUNCNAME "$@"
16 echo "in base_src_unpack, 1st parameter is $1" 56
17 [ -z "$1" ] && base_src_unpack all 57 pushd "${WORKDIR}" > /dev/null
18 58
19 while [ "$1" ]; do 59 [[ -n "${A}" ]] && unpack ${A}
20 60 has src_prepare ${BASE_EXPF} || base_src_prepare
21 case $1 in 61
22 unpack) 62 popd > /dev/null
23 echo "in base_src_unpack, action unpack"
24 unpack ${A}
25 ;;
26 all)
27 echo "in base_src_unpack, action all"
28 base_src_unpack unpack
29 ;;
30 esac
31
32 shift
33 done
34
35} 63}
36 64
65# @FUNCTION: base_src_prepare
66# @DESCRIPTION:
67# The base src_prepare function, which is exported
68# EAPI is greater or equal to 2.
37base_src_compile() { 69base_src_prepare() {
70 debug-print-function $FUNCNAME "$@"
71 debug-print "$FUNCNAME: PATCHES=$PATCHES"
38 72
39 echo "in base_src_compile, 1st parameter is $1" 73 pushd "${S}" > /dev/null
40 [ -z "$1" ] && base_src_compile all 74 if [[ "$(declare -p PATCHES 2>/dev/null 2>&1)" == "declare -a"* ]]; then
41 75 for x in "${PATCHES[@]}"; do
42 while [ "$1" ]; do 76 debug-print "$FUNCNAME: applying patch from ${x}"
43 77 if [[ -d "${x}" ]]; then
44 case $1 in 78 # Use standardized names and locations with bulk patching
45 configure) 79 # Patch directory is ${WORKDIR}/patch
46 echo "in base_src_compile, action configure" 80 # See epatch() in eutils.eclass for more documentation
47 ./configure || die 81 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
48 ;; 82
49 make) 83 # in order to preserve normal EPATCH_SOURCE value that can
50 echo "in base_src_compile, action make" 84 # be used other way than with base eclass store in local
51 make || die 85 # variable and restore later
52 ;; 86 oldval=${EPATCH_SOURCE}
53 all) 87 EPATCH_SOURCE=${x}
54 echo "in base_src_compile, action all" 88 epatch
55 base_src_compile configure make 89 EPATCH_SOURCE=${oldval}
56 ;; 90 elif [[ -f "${x}" ]]; then
57 esac 91 epatch "${x}"
58 92 else
59 shift 93 eqawarn "File or directory \"${x}\" does not exist."
60 done 94 eqawarn "Check your PATCHES array or add missing file/directory."
61 95 fi
96 done
97 else
98 for x in ${PATCHES}; do
99 debug-print "$FUNCNAME: patching from ${x}"
100 epatch "${x}"
101 done
102 fi
103
104 # Apply user patches
105 debug-print "$FUNCNAME: applying user patches"
106 epatch_user
107
108 popd > /dev/null
62} 109}
63 110
64base_src_install() { 111# @FUNCTION: base_src_configure
112# @DESCRIPTION:
113# The base src_configure function, which is exported when
114# EAPI is greater or equal to 2. Runs basic econf. Here the PATCHES array is
115# evaluated.
116base_src_configure() {
117 debug-print-function $FUNCNAME "$@"
65 118
66 echo "in base_src_install, 1st parameter is $1" 119 # there is no pushd ${S} so we can override its place where to run
67 [ -z "$1" ] && base_src_install all 120 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf
68
69 while [ "$1" ]; do
70
71 case $1 in
72 make)
73 echo "in base_src_install, action make"
74 make DESTDIR=${D} install || die
75 ;;
76 all)
77 echo "in base_src_install, action all"
78 base_src_install make
79 ;;
80 esac
81
82 shift
83 done
84
85} 121}
86 122
87EXPORT_FUNCTIONS src_unpack src_compile src_install 123# @FUNCTION: base_src_compile
124# @DESCRIPTION:
125# The base src_compile function, calls src_configure with
126# EAPI older than 2.
127base_src_compile() {
128 debug-print-function $FUNCNAME "$@"
88 129
130 has src_configure ${BASE_EXPF} || base_src_configure
131 base_src_make $@
132}
133
134# @FUNCTION: base_src_make
135# @DESCRIPTION:
136# Actual function that runs emake command.
137base_src_make() {
138 debug-print-function $FUNCNAME "$@"
139
140 if [[ -f Makefile || -f GNUmakefile || -f makefile ]]; then
141 emake $@ || die "died running emake, $FUNCNAME:make"
142 fi
143}
144
145# @FUNCTION: base_src_install
146# @DESCRIPTION:
147# The base src_install function. Runs make install and
148# installs documents and html documents from DOCS and HTML_DOCS
149# arrays.
150base_src_install() {
151 debug-print-function $FUNCNAME "$@"
152
153 emake DESTDIR="${D}" $@ install || die "died running make install, $FUNCNAME:make"
154 base_src_install_docs
155}
156
157# @FUNCTION: base_src_install_docs
158# @DESCRIPTION:
159# Actual function that install documentation from
160# DOCS and HTML_DOCS arrays.
161base_src_install_docs() {
162 debug-print-function $FUNCNAME "$@"
163
164 local x
165
166 pushd "${S}" > /dev/null
167
168 if [[ "$(declare -p DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
169 for x in "${DOCS[@]}"; do
170 debug-print "$FUNCNAME: docs: creating document from ${x}"
171 dodoc -r "${x}" || die "dodoc failed"
172 done
173 fi
174 if [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
175 for x in "${HTML_DOCS[@]}"; do
176 debug-print "$FUNCNAME: docs: creating html document from ${x}"
177 dohtml -r "${x}" || die "dohtml failed"
178 done
179 fi
180
181 popd > /dev/null
182}

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.46

  ViewVC Help
Powered by ViewVC 1.1.20