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

Contents of /eclass/base.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.53 - (show annotations) (download)
Thu May 27 08:09:33 2010 UTC (4 years, 6 months ago) by scarabeus
Branch: MAIN
Changes since 1.52: +3 -3 lines
Drop useless text in die messages.

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.52 2010/05/25 21:16:54 reavertm 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. Here the PATCHES array is evaluated.
69 base_src_prepare() {
70 debug-print-function $FUNCNAME "$@"
71 debug-print "$FUNCNAME: PATCHES=$PATCHES"
72
73 local patches_failed=0
74
75 pushd "${S}" > /dev/null
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}
84
85 # in order to preserve normal EPATCH_SOURCE value that can
86 # be used other way than with base eclass store in local
87 # variable and restore later
88 oldval=${EPATCH_SOURCE}
89 EPATCH_SOURCE=${x}
90 EPATCH_FORCE=yes
91 epatch
92 EPATCH_SOURCE=${oldval}
93 elif [[ -f "${x}" ]]; then
94 epatch "${x}"
95 else
96 ewarn "QA: File or directory \"${x}\" does not exist."
97 ewarn "QA: Check your PATCHES array or add missing file/directory."
98 patches_failed=1
99 fi
100 done
101 [[ ${patches_failed} -eq 1 ]] && die "Some patches failed. See above messages."
102 else
103 for x in ${PATCHES}; do
104 debug-print "$FUNCNAME: patching from ${x}"
105 epatch "${x}"
106 done
107 fi
108
109 # Apply user patches
110 debug-print "$FUNCNAME: applying user patches"
111 epatch_user
112
113 popd > /dev/null
114 }
115
116 # @FUNCTION: base_src_configure
117 # @DESCRIPTION:
118 # The base src_configure function, which is exported when
119 # EAPI is greater or equal to 2. Runs basic econf.
120 base_src_configure() {
121 debug-print-function $FUNCNAME "$@"
122
123 # there is no pushd ${S} so we can override its place where to run
124 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf "$@"
125 }
126
127 # @FUNCTION: base_src_compile
128 # @DESCRIPTION:
129 # The base src_compile function, calls src_configure with
130 # EAPI older than 2.
131 base_src_compile() {
132 debug-print-function $FUNCNAME "$@"
133
134 has src_configure ${BASE_EXPF} || base_src_configure
135 base_src_make "$@"
136 }
137
138 # @FUNCTION: base_src_make
139 # @DESCRIPTION:
140 # Actual function that runs emake command.
141 base_src_make() {
142 debug-print-function $FUNCNAME "$@"
143
144 if [[ -f Makefile || -f GNUmakefile || -f makefile ]]; then
145 emake "$@" || die "died running emake, $FUNCNAME"
146 fi
147 }
148
149 # @FUNCTION: base_src_install
150 # @DESCRIPTION:
151 # The base src_install function. Runs make install and
152 # installs documents and html documents from DOCS and HTML_DOCS
153 # arrays.
154 base_src_install() {
155 debug-print-function $FUNCNAME "$@"
156
157 emake DESTDIR="${D}" "$@" install || die "died running make install, $FUNCNAME"
158 base_src_install_docs
159 }
160
161 # @FUNCTION: base_src_install_docs
162 # @DESCRIPTION:
163 # Actual function that install documentation from
164 # DOCS and HTML_DOCS arrays.
165 base_src_install_docs() {
166 debug-print-function $FUNCNAME "$@"
167
168 local x
169
170 pushd "${S}" > /dev/null
171
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 "${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
184
185 popd > /dev/null
186 }

  ViewVC Help
Powered by ViewVC 1.1.20