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

Diff of /eclass/base.eclass

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

Revision 1.10 Revision 1.48
1# Copyright 1999-2000 Gentoo Technologies, Inc. 1# Copyright 1999-2008 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License, v2 or later 2# Distributed under the terms of the GNU General Public License v2
3# Author Dan Armak <danarmak@gentoo.org>
4# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.10 2002/02/06 20:38:10 danarmak Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.48 2010/01/24 13:43:26 scarabeus Exp $
5# The base eclass defines some default functions and variables. Nearly everything
6# else inherits from here.
7inherit functions
8ECLASS=base
9 4
10S=${WORKDIR}/${P} 5# @ECLASS: base.eclass
11DESCRIPTION="Based on the $ECLASS 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.
12 14
15inherit eutils
16
17BASE_EXPF="src_unpack src_compile src_install"
18case "${EAPI:-0}" in
19 2|3|4) BASE_EXPF+=" src_prepare src_configure" ;;
20 *) ;;
21esac
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.
13base_src_unpack() { 54base_src_unpack() {
55 debug-print-function $FUNCNAME "$@"
14 56
15 debug-print-function $FUNCNAME $* 57 pushd "${WORKDIR}" > /dev/null
16 [ -z "$1" ] && base_src_unpack all
17 58
18 while [ "$1" ]; do 59 [[ -n "${A}" ]] && unpack ${A}
60 has src_prepare ${BASE_EXPF} || base_src_prepare
19 61
20 case $1 in 62 popd > /dev/null
21 unpack)
22 debug-print-section unpack
23 unpack ${A}
24 ;;
25 patch)
26 debug-print-section patch
27 cd ${S}
28 patch -p0 < ${FILESDIR}/${P}-gentoo.diff
29 ;;
30 all)
31 debug-print-section all
32 base_src_unpack unpack
33 ;;
34 esac
35
36 shift
37 done
38
39} 63}
40 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.
41base_src_compile() { 69base_src_prepare() {
70 debug-print-function $FUNCNAME "$@"
71 debug-print "$FUNCNAME: PATCHES=$PATCHES"
42 72
43 debug-print-function $FUNCNAME $* 73 local patches_failed=0
44 [ -z "$1" ] && base_src_compile all
45 74
46 while [ "$1" ]; do 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}
47 84
48 case $1 in 85 # in order to preserve normal EPATCH_SOURCE value that can
49 configure) 86 # be used other way than with base eclass store in local
50 debug-print-section configure 87 # variable and restore later
51 ./configure || die 88 oldval=${EPATCH_SOURCE}
52 ;; 89 EPATCH_SOURCE=${x}
53 make) 90 epatch
54 debug-print-section make 91 EPATCH_SOURCE=${oldval}
55 make || die 92 elif [[ -f "${x}" ]]; then
56 ;; 93 epatch "${x}"
57 all) 94 else
58 debug-print-section all 95 ewarn "QA: File or directory \"${x}\" does not exist."
59 base_src_compile configure make 96 ewarn "QA: Check your PATCHES array or add missing file/directory."
60 ;; 97 patches_failed=1
61 esac 98 fi
62 99 done
63 shift 100 [[ ${patches_failed} -eq 1 ]] && die "Some patches failed. See above messages."
64 done 101 else
65 102 for x in ${PATCHES}; do
103 debug-print "$FUNCNAME: patching from ${x}"
104 epatch "${x}"
105 done
106 fi
107
108 # Apply user patches
109 debug-print "$FUNCNAME: applying user patches"
110 epatch_user
111
112 popd > /dev/null
66} 113}
67 114
68base_src_install() { 115# @FUNCTION: base_src_configure
116# @DESCRIPTION:
117# The base src_configure function, which is exported when
118# EAPI is greater or equal to 2. Runs basic econf. Here the PATCHES array is
119# evaluated.
120base_src_configure() {
121 debug-print-function $FUNCNAME "$@"
69 122
70 debug-print-function $FUNCNAME $* 123 # there is no pushd ${S} so we can override its place where to run
71 [ -z "$1" ] && base_src_install all 124 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf
72
73 while [ "$1" ]; do
74
75 case $1 in
76 make)
77 debug-print-section make
78 make DESTDIR=${D} install || die
79 ;;
80 all)
81 debug-prnit-section all
82 base_src_install make
83 ;;
84 esac
85
86 shift
87 done
88
89} 125}
90 126
91EXPORT_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 "$@"
92 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:make"
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:make"
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 -r "${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.10  
changed lines
  Added in v.1.48
  ViewVC Help
Powered by ViewVC 1.1.13