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

Contents of /eclass/base.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.41 - (show annotations) (download)
Mon Jan 11 16:57:46 2010 UTC (4 years, 11 months ago) by scarabeus
Branch: MAIN
Changes since 1.40: +108 -162 lines
Update maintainership to be qa@g.o
Features information:
PATCHES now accept also folders as their argument.
New arrays DOCS and HTML_DOCS, also bash arrays as patches.
src_install calls emake and not make.
switched from "function argument" layout to separate functions.
Review request submited: http://archives.gentoo.org/gentoo-dev/msg_254665435d58a97bcc5a952e5e005cd1.xml

1 # Copyright 1999-2008 Gentoo Foundation
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 $
4
5 # @ECLASS: base.eclass
6 # @MAINTAINER:
7 # QA Team <qa@gentoo.org>
8 #
9 # Original author Dan Armak <danarmak@gentoo.org>
10 # @BLURB: The base eclass defines some default functions and variables.
11 # @DESCRIPTION:
12 # The base eclass defines some default functions and variables. Nearly
13 # everything else inherits from here.
14
15 inherit eutils
16
17 BASE_EXPF="src_unpack src_compile src_install"
18 case "${EAPI:-0}" in
19 2|3|4) BASE_EXPF="src_prepare src_configure" ;;
20 *) ;;
21 esac
22
23 EXPORT_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
45
46 # @FUNCTION: base_src_unpack
47 # @DESCRIPTION:
48 # The base src_unpack function, which is exported.
49 # Calls also src_prepare with eapi older than 2.
50 base_src_unpack() {
51 debug-print-function $FUNCNAME "$@"
52
53 pushd "${WORKDIR}" > /dev/null
54
55 [[ -n "${A}" ]] && unpack ${A}
56 has src_prepare ${BASE_EXPF} || base_src_prepare
57
58 popd > /dev/null
59 }
60
61 # @FUNCTION: base_src_prepare
62 # @DESCRIPTION:
63 # The base src_prepare function, which is exported
64 # EAPI is greater or equal to 2.
65 base_src_prepare() {
66 debug-print-function $FUNCNAME "$@"
67 debug-print "$FUNCNAME: PATCHES=$PATCHES"
68
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}
79
80 # in order to preserve normal EPATCH_SOURCE value that can
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
95
96 # Apply user patches
97 debug-print "$FUNCNAME: applying user patches"
98 epatch_user
99
100 popd > /dev/null
101 }
102
103 # @FUNCTION: base_src_configure
104 # @DESCRIPTION:
105 # The base src_configure function, which is exported when
106 # EAPI is greater or equal to 2. Runs basic econf.
107 base_src_configure() {
108 debug-print-function $FUNCNAME "$@"
109
110 # there is no pushd ${S} so we can override its place where to run
111 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf
112 }
113
114 # @FUNCTION: base_src_compile
115 # @DESCRIPTION:
116 # The base src_compile function, calls src_configure with
117 # EAPI older than 2.
118 base_src_compile() {
119 debug-print-function $FUNCNAME "$@"
120
121 has src_configure ${BASE_EXPF} || base_src_configure
122 base_src_make $@
123 }
124
125 # @FUNCTION: base_src_make
126 # @DESCRIPTION:
127 # Actual function that runs emake command.
128 base_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"
133 fi
134 }
135
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.
141 base_src_install() {
142 debug-print-function $FUNCNAME "$@"
143
144 emake DESTDIR="${D}" $@ install || die "died running make install, $FUNCNAME:make"
145 base_src_install_docs
146 }
147
148 # @FUNCTION: base_src_install_docs
149 # @DESCRIPTION:
150 # Actual function that install documentation from
151 # DOCS and HTML_DOCS arrays.
152 base_src_install_docs() {
153 debug-print-function $FUNCNAME "$@"
154
155 local x
156
157 pushd "${S}" > /dev/null
158
159 if [[ "$(declare -p DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
160 for x in "${DOCS[@]}"; do
161 debug-print "$FUNCNAME: docs: creating document from ${x}"
162 dodoc -r "${x}" || die "dodoc failed"
163 done
164 fi
165 if [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
166 for x in "${HTML_DOCS[@]}"; do
167 debug-print "$FUNCNAME: docs: creating html document from ${x}"
168 dohtml -r "${x}" || die "dohtml failed"
169 done
170 fi
171
172 popd > /dev/null
173 }

  ViewVC Help
Powered by ViewVC 1.1.20