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

Contents of /eclass/base.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.46 - (show annotations) (download)
Wed Jan 20 19:21:19 2010 UTC (4 years, 3 months ago) by scarabeus
Branch: MAIN
Changes since 1.45: +5 -2 lines
Do not die when PATCHES content cant be found. Just print evil QA warning.

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.45 2010/01/20 12:57:13 spatz 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 # @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
49
50 # @FUNCTION: base_src_unpack
51 # @DESCRIPTION:
52 # The base src_unpack function, which is exported.
53 # Calls also src_prepare with eapi older than 2.
54 base_src_unpack() {
55 debug-print-function $FUNCNAME "$@"
56
57 pushd "${WORKDIR}" > /dev/null
58
59 [[ -n "${A}" ]] && unpack ${A}
60 has src_prepare ${BASE_EXPF} || base_src_prepare
61
62 popd > /dev/null
63 }
64
65 # @FUNCTION: base_src_prepare
66 # @DESCRIPTION:
67 # The base src_prepare function, which is exported
68 # EAPI is greater or equal to 2.
69 base_src_prepare() {
70 debug-print-function $FUNCNAME "$@"
71 debug-print "$FUNCNAME: PATCHES=$PATCHES"
72
73 pushd "${S}" > /dev/null
74 if [[ "$(declare -p PATCHES 2>/dev/null 2>&1)" == "declare -a"* ]]; then
75 for x in "${PATCHES[@]}"; do
76 debug-print "$FUNCNAME: applying patch from ${x}"
77 if [[ -d "${x}" ]]; then
78 # Use standardized names and locations with bulk patching
79 # Patch directory is ${WORKDIR}/patch
80 # See epatch() in eutils.eclass for more documentation
81 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
82
83 # in order to preserve normal EPATCH_SOURCE value that can
84 # be used other way than with base eclass store in local
85 # variable and restore later
86 oldval=${EPATCH_SOURCE}
87 EPATCH_SOURCE=${x}
88 epatch
89 EPATCH_SOURCE=${oldval}
90 elif [[ -f "${x}" ]]; then
91 epatch "${x}"
92 else
93 eqawarn "File or directory \"${x}\" does not exist."
94 eqawarn "Check your PATCHES array or add missing file/directory."
95 fi
96 done
97 else
98 for x in ${PATCHES}; do
99 debug-print "$FUNCNAME: patching from ${x}"
100 epatch "${x}"
101 done
102 fi
103
104 # Apply user patches
105 debug-print "$FUNCNAME: applying user patches"
106 epatch_user
107
108 popd > /dev/null
109 }
110
111 # @FUNCTION: base_src_configure
112 # @DESCRIPTION:
113 # The base src_configure function, which is exported when
114 # EAPI is greater or equal to 2. Runs basic econf. Here the PATCHES array is
115 # evaluated.
116 base_src_configure() {
117 debug-print-function $FUNCNAME "$@"
118
119 # there is no pushd ${S} so we can override its place where to run
120 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf
121 }
122
123 # @FUNCTION: base_src_compile
124 # @DESCRIPTION:
125 # The base src_compile function, calls src_configure with
126 # EAPI older than 2.
127 base_src_compile() {
128 debug-print-function $FUNCNAME "$@"
129
130 has src_configure ${BASE_EXPF} || base_src_configure
131 base_src_make $@
132 }
133
134 # @FUNCTION: base_src_make
135 # @DESCRIPTION:
136 # Actual function that runs emake command.
137 base_src_make() {
138 debug-print-function $FUNCNAME "$@"
139
140 if [[ -f Makefile || -f GNUmakefile || -f makefile ]]; then
141 emake $@ || die "died running emake, $FUNCNAME:make"
142 fi
143 }
144
145 # @FUNCTION: base_src_install
146 # @DESCRIPTION:
147 # The base src_install function. Runs make install and
148 # installs documents and html documents from DOCS and HTML_DOCS
149 # arrays.
150 base_src_install() {
151 debug-print-function $FUNCNAME "$@"
152
153 emake DESTDIR="${D}" $@ install || die "died running make install, $FUNCNAME:make"
154 base_src_install_docs
155 }
156
157 # @FUNCTION: base_src_install_docs
158 # @DESCRIPTION:
159 # Actual function that install documentation from
160 # DOCS and HTML_DOCS arrays.
161 base_src_install_docs() {
162 debug-print-function $FUNCNAME "$@"
163
164 local x
165
166 pushd "${S}" > /dev/null
167
168 if [[ "$(declare -p DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
169 for x in "${DOCS[@]}"; do
170 debug-print "$FUNCNAME: docs: creating document from ${x}"
171 dodoc -r "${x}" || die "dodoc failed"
172 done
173 fi
174 if [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
175 for x in "${HTML_DOCS[@]}"; do
176 debug-print "$FUNCNAME: docs: creating html document from ${x}"
177 dohtml -r "${x}" || die "dohtml failed"
178 done
179 fi
180
181 popd > /dev/null
182 }

  ViewVC Help
Powered by ViewVC 1.1.20