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

Diff of /eclass/base.eclass

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

Revision 1.36 Revision 1.48
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.36 2009/01/17 16:56:55 mr_bones_ Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.48 2010/01/24 13:43:26 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# @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.
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
91 EPATCH_SOURCE=${oldval}
92 elif [[ -f "${x}" ]]; then
93 epatch "${x}"
94 else
95 ewarn "QA: File or directory \"${x}\" does not exist."
96 ewarn "QA: Check your PATCHES array or add missing file/directory."
97 patches_failed=1
98 fi
99 done
100 [[ ${patches_failed} -eq 1 ]] && die "Some patches failed. See above messages."
101 else
102 for x in ${PATCHES}; do
103 debug-print "$FUNCNAME: patching from ${x}"
104 epatch "${x}"
105 done
106 fi
72 107
73 debug-print-function $FUNCNAME "$@" 108 # Apply user patches
109 debug-print "$FUNCNAME: applying user patches"
110 epatch_user
74 111
75 cd "${WORKDIR}" 112 popd > /dev/null
76
77 while [ "$1" ]; do
78
79 case $1 in
80 unpack)
81 debug-print-section unpack
82 if [ ! -z "$A" ] ; then
83 unpack ${A}
84 fi
85 ;;
86 patch)
87 debug-print-section patch
88 cd "${S}"
89 epatch "${FILESDIR}/${P}-gentoo.diff"
90 ;;
91 autopatch)
92 debug-print-section autopatch
93 debug-print "$FUNCNAME: autopatch: PATCHES=$PATCHES, PATCHES1=$PATCHES1"
94 cd "${S}"
95 if [[ ${#PATCHES[@]} -gt 1 ]] ; then
96 for x in "${PATCHES[@]}"; do
97 debug-print "$FUNCNAME: autopatch: patching from ${x}"
98 epatch "${x}"
99 done
100 else
101 for x in ${PATCHES} ${PATCHES1}; do
102 debug-print "$FUNCNAME: autopatch: patching from ${x}"
103 epatch "${x}"
104 done
105 fi
106 ;;
107 all)
108 debug-print-section all
109 base_src_util unpack autopatch
110 ;;
111 esac
112
113 shift
114 done
115
116} 113}
117 114
118# @FUNCTION: base_src_configure 115# @FUNCTION: base_src_configure
119# @DESCRIPTION: 116# @DESCRIPTION:
120# The base src_prepare function, which is exported when EAPI=2. Performs 117# The base src_configure function, which is exported when
121# "base_src_work configure". 118# EAPI is greater or equal to 2. Runs basic econf. Here the PATCHES array is
119# evaluated.
122base_src_configure() { 120base_src_configure() {
123
124 debug-print-function $FUNCNAME "$@" 121 debug-print-function $FUNCNAME "$@"
125 122
126 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
127} 125}
128 126
129# @FUNCTION: base_src_compile 127# @FUNCTION: base_src_compile
130# @USAGE: [ configure ] [ make ] [ all ]
131# @DESCRIPTION: 128# @DESCRIPTION:
132# The base src_compile function, which is exported. If no argument is given, 129# The base src_compile function, calls src_configure with
133# "all" is assumed if EAPI!=2, "make" if EAPI=2. 130# EAPI older than 2.
134base_src_compile() { 131base_src_compile() {
135
136 debug-print-function $FUNCNAME "$@" 132 debug-print-function $FUNCNAME "$@"
137 133
138 if [ -z "$1" ] 134 has src_configure ${BASE_EXPF} || base_src_configure
139 then
140 case "${EAPI:-0}" in
141 2)
142 base_src_work make
143 ;;
144 *)
145 base_src_work all
146 ;;
147 esac
148 else
149 base_src_work $@ 135 base_src_make $@
136}
137
138# @FUNCTION: base_src_make
139# @DESCRIPTION:
140# Actual function that runs emake command.
141base_src_make() {
142 debug-print-function $FUNCNAME "$@"
143
144 if [[ -f Makefile || -f GNUmakefile || -f makefile ]]; then
145 emake $@ || die "died running emake, $FUNCNAME:make"
150 fi 146 fi
151} 147}
152 148
153# @FUNCTION: base_src_work 149# @FUNCTION: base_src_install
154# @USAGE: [ configure ] [ make ] [ all ]
155# @DESCRIPTION: 150# @DESCRIPTION:
156# The base_src_work function is the grunt function for base src_configure 151# The base src_install function. Runs make install and
157# and base src_compile. 152# installs documents and html documents from DOCS and HTML_DOCS
158base_src_work() { 153# arrays.
159 154base_src_install() {
160 debug-print-function $FUNCNAME "$@" 155 debug-print-function $FUNCNAME "$@"
161 156
162 cd "${S}" 157 emake DESTDIR="${D}" $@ install || die "died running make install, $FUNCNAME:make"
163 158 base_src_install_docs
164 while [ "$1" ]; do
165
166 case $1 in
167 configure)
168 debug-print-section configure
169 econf || die "died running econf, $FUNCNAME:configure"
170 ;;
171 make)
172 debug-print-section make
173 emake || die "died running emake, $FUNCNAME:make"
174 ;;
175 all)
176 debug-print-section all
177 base_src_work configure make
178 ;;
179 esac
180
181 shift
182 done
183
184} 159}
185 160
186# @FUNCTION: base_src_install 161# @FUNCTION: base_src_install_docs
187# @USAGE: [ make ] [ all ]
188# @DESCRIPTION: 162# @DESCRIPTION:
189# The base src_install function, which is exported. If no argument is given, 163# Actual function that install documentation from
190# "all" is assumed. 164# DOCS and HTML_DOCS arrays.
191base_src_install() { 165base_src_install_docs() {
166 debug-print-function $FUNCNAME "$@"
192 167
193 debug-print-function $FUNCNAME "$@" 168 local x
194 [ -z "$1" ] && base_src_install all
195 169
196 cd "${S}" 170 pushd "${S}" > /dev/null
197 171
198 while [ "$1" ]; do 172 if [[ "$(declare -p DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
173 for x in "${DOCS[@]}"; do
174 debug-print "$FUNCNAME: docs: creating document from ${x}"
175 dodoc -r "${x}" || die "dodoc failed"
176 done
177 fi
178 if [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
179 for x in "${HTML_DOCS[@]}"; do
180 debug-print "$FUNCNAME: docs: creating html document from ${x}"
181 dohtml -r "${x}" || die "dohtml failed"
182 done
183 fi
199 184
200 case $1 in 185 popd > /dev/null
201 make)
202 debug-print-section make
203 make DESTDIR="${D}" install || die "died running make install, $FUNCNAME:make"
204 ;;
205 all)
206 debug-print-section all
207 base_src_install make
208 ;;
209 esac
210
211 shift
212 done
213
214} 186}

Legend:
Removed from v.1.36  
changed lines
  Added in v.1.48

  ViewVC Help
Powered by ViewVC 1.1.20