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

Diff of /eclass/base.eclass

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

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

Legend:
Removed from v.1.38  
changed lines
  Added in v.1.55

  ViewVC Help
Powered by ViewVC 1.1.20