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

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

  ViewVC Help
Powered by ViewVC 1.1.20