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

Diff of /eclass/base.eclass

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

Revision 1.39 Revision 1.52
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.39 2010/01/03 19:13:44 scarabeus Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.52 2010/05/25 21:16:54 reavertm 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# @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
31 49
32# @FUNCTION: base_src_unpack 50# @FUNCTION: base_src_unpack
33# @USAGE: [ unpack ] [ patch ] [ autopatch ] [ all ]
34# @DESCRIPTION: 51# @DESCRIPTION:
35# The base src_unpack function, which is exported. If no argument is given, 52# The base src_unpack function, which is exported.
36# "all" is assumed if EAPI!=2, "unpack" if EAPI=2. 53# Calls also src_prepare with eapi older than 2.
37base_src_unpack() { 54base_src_unpack() {
38
39 debug-print-function $FUNCNAME "$@" 55 debug-print-function $FUNCNAME "$@"
40 56
41 if [ -z "$1" ] ; then 57 pushd "${WORKDIR}" > /dev/null
42 case "${EAPI:-0}" in 58
43 2) 59 [[ -n "${A}" ]] && unpack ${A}
44 base_src_util unpack 60 has src_prepare ${BASE_EXPF} || base_src_prepare
45 ;; 61
46 *) 62 popd > /dev/null
47 base_src_util all
48 ;;
49 esac
50 else
51 base_src_util $@
52 fi
53} 63}
54 64
55# @FUNCTION: base_src_prepare 65# @FUNCTION: base_src_prepare
56# @DESCRIPTION: 66# @DESCRIPTION:
57# The base src_prepare function, which is exported when EAPI=2. Performs 67# The base src_prepare function, which is exported
58# "base_src_util autopatch". 68# EAPI is greater or equal to 2. Here the PATCHES array is evaluated.
59base_src_prepare() { 69base_src_prepare() {
70 debug-print-function $FUNCNAME "$@"
71 debug-print "$FUNCNAME: PATCHES=$PATCHES"
60 72
61 debug-print-function $FUNCNAME "$@" 73 local patches_failed=0
62 74
63 base_src_util autopatch 75 pushd "${S}" > /dev/null
64} 76 if [[ "$(declare -p PATCHES 2>/dev/null 2>&1)" == "declare -a"* ]]; then
77 for x in "${PATCHES[@]}"; do
78 debug-print "$FUNCNAME: applying patch from ${x}"
79 if [[ -d "${x}" ]]; then
80 # Use standardized names and locations with bulk patching
81 # Patch directory is ${WORKDIR}/patch
82 # See epatch() in eutils.eclass for more documentation
83 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
65 84
66# @FUNCTION: base_src_util 85 # in order to preserve normal EPATCH_SOURCE value that can
67# @USAGE: [ unpack ] [ patch ] [ autopatch ] [ all ] 86 # be used other way than with base eclass store in local
68# @DESCRIPTION: 87 # variable and restore later
69# The base_src_util function is the grunt function for base src_unpack 88 oldval=${EPATCH_SOURCE}
70# and base src_prepare. 89 EPATCH_SOURCE=${x}
71base_src_util() { 90 EPATCH_FORCE=yes
72 local x 91 epatch
92 EPATCH_SOURCE=${oldval}
93 elif [[ -f "${x}" ]]; then
94 epatch "${x}"
95 else
96 ewarn "QA: File or directory \"${x}\" does not exist."
97 ewarn "QA: Check your PATCHES array or add missing file/directory."
98 patches_failed=1
99 fi
100 done
101 [[ ${patches_failed} -eq 1 ]] && die "Some patches failed. See above messages."
102 else
103 for x in ${PATCHES}; do
104 debug-print "$FUNCNAME: patching from ${x}"
105 epatch "${x}"
106 done
107 fi
73 108
74 debug-print-function $FUNCNAME "$@" 109 # Apply user patches
110 debug-print "$FUNCNAME: applying user patches"
111 epatch_user
75 112
76 cd "${WORKDIR}" 113 popd > /dev/null
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} 114}
118 115
119# @FUNCTION: base_src_configure 116# @FUNCTION: base_src_configure
120# @DESCRIPTION: 117# @DESCRIPTION:
121# The base src_prepare function, which is exported when EAPI=2. Performs 118# The base src_configure function, which is exported when
122# "base_src_work configure". 119# EAPI is greater or equal to 2. Runs basic econf.
123base_src_configure() { 120base_src_configure() {
124
125 debug-print-function $FUNCNAME "$@" 121 debug-print-function $FUNCNAME "$@"
126 122
127 base_src_work configure 123 # there is no pushd ${S} so we can override its place where to run
124 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf "$@"
128} 125}
129 126
130# @FUNCTION: base_src_compile 127# @FUNCTION: base_src_compile
131# @USAGE: [ configure ] [ make ] [ all ]
132# @DESCRIPTION: 128# @DESCRIPTION:
133# The base src_compile function, which is exported. If no argument is given, 129# The base src_compile function, calls src_configure with
134# "all" is assumed if EAPI!=2, "make" if EAPI=2. 130# EAPI older than 2.
135base_src_compile() { 131base_src_compile() {
136
137 debug-print-function $FUNCNAME "$@" 132 debug-print-function $FUNCNAME "$@"
138 133
139 if [ -z "$1" ] 134 has src_configure ${BASE_EXPF} || base_src_configure
140 then 135 base_src_make "$@"
141 case "${EAPI:-0}" in 136}
142 2) 137
143 base_src_work make 138# @FUNCTION: base_src_make
144 ;; 139# @DESCRIPTION:
145 *) 140# Actual function that runs emake command.
146 base_src_work all 141base_src_make() {
147 ;; 142 debug-print-function $FUNCNAME "$@"
148 esac 143
149 else 144 if [[ -f Makefile || -f GNUmakefile || -f makefile ]]; then
150 base_src_work $@ 145 emake "$@" || die "died running emake, $FUNCNAME:make"
151 fi 146 fi
152} 147}
153 148
154# placeholder for future api so eclasses can be migrated now. 149# @FUNCTION: base_src_install
150# @DESCRIPTION:
151# The base src_install function. Runs make install and
152# installs documents and html documents from DOCS and HTML_DOCS
153# arrays.
155base_src_make() { 154base_src_install() {
156 debug-print-fucntion $FUNCNAME "$@" 155 debug-print-function $FUNCNAME "$@"
157 base_src_work make 156
157 emake DESTDIR="${D}" "$@" install || die "died running make install, $FUNCNAME:make"
158 base_src_install_docs
158} 159}
159 160
160# @FUNCTION: base_src_work 161# @FUNCTION: base_src_install_docs
161# @USAGE: [ configure ] [ make ] [ all ]
162# @DESCRIPTION: 162# @DESCRIPTION:
163# The base_src_work function is the grunt function for base src_configure 163# Actual function that install documentation from
164# and base src_compile. 164# DOCS and HTML_DOCS arrays.
165base_src_work() { 165base_src_install_docs() {
166
167 debug-print-function $FUNCNAME "$@" 166 debug-print-function $FUNCNAME "$@"
168 167
169 cd "${S}" 168 local x
170 169
171 while [ "$1" ]; do 170 pushd "${S}" > /dev/null
172 171
173 case $1 in 172 if [[ "$(declare -p DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
174 configure) 173 for x in "${DOCS[@]}"; do
175 debug-print-section configure 174 debug-print "$FUNCNAME: docs: creating document from ${x}"
176 if [[ -x ${ECONF_SOURCE:-.}/configure ]] 175 dodoc "${x}" || die "dodoc failed"
177 then 176 done
178 econf || die "died running econf, $FUNCNAME:configure"
179 fi 177 fi
180 ;; 178 if [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
181 make) 179 for x in "${HTML_DOCS[@]}"; do
182 debug-print-section make 180 debug-print "$FUNCNAME: docs: creating html document from ${x}"
183 if [ -f Makefile ] || [ -f GNUmakefile ] || [ -f makefile ] 181 dohtml -r "${x}" || die "dohtml failed"
184 then 182 done
185 emake || die "died running emake, $FUNCNAME:make"
186 fi 183 fi
187 ;;
188 all)
189 debug-print-section all
190 base_src_work configure make
191 ;;
192 esac
193 184
194 shift 185 popd > /dev/null
195 done
196
197} 186}
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.39  
changed lines
  Added in v.1.52

  ViewVC Help
Powered by ViewVC 1.1.20