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

Diff of /eclass/base.eclass

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

Revision 1.31 Revision 1.53
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2008 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.31 2007/09/12 20:05:33 betelgeuse Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.53 2010/05/27 08:09:33 scarabeus Exp $
4
5# @ECLASS: base.eclass
6# @MAINTAINER:
7# QA Team <qa@gentoo.org>
4# 8#
5# Author Dan Armak <danarmak@gentoo.org> (nowadays retired) 9# Original author Dan Armak <danarmak@gentoo.org>
6# 10# @BLURB: The base eclass defines some default functions and variables.
11# @DESCRIPTION:
7# The base eclass defines some default functions and variables. Nearly everything 12# The base eclass defines some default functions and variables. Nearly
8# else inherits from here. 13# everything else inherits from here.
9 14
10inherit eutils 15inherit eutils
11 16
12DESCRIPTION="Based on the $ECLASS eclass" 17BASE_EXPF="src_unpack src_compile src_install"
18case "${EAPI:-0}" in
19 2|3|4) BASE_EXPF+=" src_prepare src_configure" ;;
20 *) ;;
21esac
13 22
23EXPORT_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.
14base_src_unpack() { 54base_src_unpack() {
55 debug-print-function $FUNCNAME "$@"
15 56
16 debug-print-function $FUNCNAME $* 57 pushd "${WORKDIR}" > /dev/null
17 [ -z "$1" ] && base_src_unpack all
18 58
19 cd ${WORKDIR} 59 [[ -n "${A}" ]] && unpack ${A}
60 has src_prepare ${BASE_EXPF} || base_src_prepare
20 61
21 while [ "$1" ]; do 62 popd > /dev/null
22
23 case $1 in
24 unpack)
25 debug-print-section unpack
26 unpack ${A}
27 ;;
28 patch)
29 debug-print-section patch
30 cd ${S}
31 epatch ${FILESDIR}/${P}-gentoo.diff
32 ;;
33 autopatch)
34 debug-print-section autopatch
35 debug-print "$FUNCNAME: autopatch: PATCHES=$PATCHES, PATCHES1=$PATCHES1"
36 cd ${S}
37 for x in $PATCHES $PATCHES1; do
38 debug-print "$FUNCNAME: autopatch: patching from ${x}"
39 epatch ${x}
40 done
41 ;;
42 all)
43 debug-print-section all
44 base_src_unpack unpack autopatch
45 ;;
46 esac
47
48 shift
49 done
50
51} 63}
52 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.
53base_src_compile() { 69base_src_prepare() {
70 debug-print-function $FUNCNAME "$@"
71 debug-print "$FUNCNAME: PATCHES=$PATCHES"
54 72
55 debug-print-function $FUNCNAME $* 73 local patches_failed=0
56 [ -z "$1" ] && base_src_compile all
57 74
58 cd ${S} 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}
59 84
60 while [ "$1" ]; do 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
61 108
62 case $1 in 109 # Apply user patches
63 configure) 110 debug-print "$FUNCNAME: applying user patches"
64 debug-print-section configure 111 epatch_user
65 econf || die "died running econf, $FUNCNAME:configure"
66 ;;
67 make)
68 debug-print-section make
69 emake || die "died running emake, $FUNCNAME:make"
70 ;;
71 all)
72 debug-print-section all
73 base_src_compile configure make
74 ;;
75 esac
76 112
77 shift 113 popd > /dev/null
78 done
79
80} 114}
81 115
82base_src_install() { 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.
120base_src_configure() {
121 debug-print-function $FUNCNAME "$@"
83 122
84 debug-print-function $FUNCNAME $* 123 # there is no pushd ${S} so we can override its place where to run
85 [ -z "$1" ] && base_src_install all 124 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf "$@"
86
87 cd ${S}
88
89 while [ "$1" ]; do
90
91 case $1 in
92 make)
93 debug-print-section make
94 make DESTDIR=${D} install || die "died running make install, $FUNCNAME:make"
95 ;;
96 all)
97 debug-print-section all
98 base_src_install make
99 ;;
100 esac
101
102 shift
103 done
104
105} 125}
106 126
107EXPORT_FUNCTIONS src_unpack src_compile src_install 127# @FUNCTION: base_src_compile
128# @DESCRIPTION:
129# The base src_compile function, calls src_configure with
130# EAPI older than 2.
131base_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.
141base_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.
154base_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.
165base_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}

Legend:
Removed from v.1.31  
changed lines
  Added in v.1.53

  ViewVC Help
Powered by ViewVC 1.1.20