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

Diff of /eclass/base.eclass

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

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

Legend:
Removed from v.1.40  
changed lines
  Added in v.1.41

  ViewVC Help
Powered by ViewVC 1.1.20