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

Diff of /eclass/base.eclass

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

Revision 1.2 Revision 1.58
1# Copyright 1999-2000 Gentoo Technologies, Inc. 1# Copyright 1999-2012 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.2 2001/09/28 19:30:09 danarmak Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.58 2012/09/27 16:35:41 axs Exp $
5# The base eclass defines some default functions and variables. Nearly everything
6# else inherits from here.
7. /usr/portage/eclass/inherit.eclass || die
8inherit virtual || die
9ECLASS=base
10 4
11S=${WORKDIR}/${P} 5# @ECLASS: base.eclass
12DESCRIPTION="Based on the $ECLASS eclass" 6# @MAINTAINER:
7# QA Team <qa@gentoo.org>
8# @AUTHOR:
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.
13 13
14if [[ ${___ECLASS_ONCE_BASE} != "recur -_+^+_- spank" ]] ; then
15___ECLASS_ONCE_BASE="recur -_+^+_- spank"
16
17inherit eutils
18
19BASE_EXPF="src_unpack src_compile src_install"
20case "${EAPI:-0}" in
21 2|3|4|5) BASE_EXPF+=" src_prepare src_configure" ;;
22 *) ;;
23esac
24
25EXPORT_FUNCTIONS ${BASE_EXPF}
26
27# @ECLASS-VARIABLE: DOCS
28# @DESCRIPTION:
29# Array containing documents passed to dodoc command.
30#
31# DOCS=( "${S}/doc/document.txt" "${S}/doc/doc_folder/" )
32
33# @ECLASS-VARIABLE: HTML_DOCS
34# @DESCRIPTION:
35# Array containing documents passed to dohtml command.
36#
37# HTML_DOCS=( "${S}/doc/document.html" "${S}/doc/html_folder/" )
38
39# @ECLASS-VARIABLE: PATCHES
40# @DESCRIPTION:
41# PATCHES array variable containing all various patches to be applied.
42# This variable is expected to be defined in global scope of ebuild.
43# Make sure to specify the full path. This variable is utilised in
44# src_unpack/src_prepare phase based on EAPI.
45#
46# NOTE: if using patches folders with special file suffixes you have to
47# define one additional variable EPATCH_SUFFIX="something"
48#
49# PATCHES=( "${FILESDIR}/mypatch.patch" "${FILESDIR}/patches_folder/" )
50
51
52# @FUNCTION: base_src_unpack
53# @DESCRIPTION:
54# The base src_unpack function, which is exported.
55# Calls also src_prepare with eapi older than 2.
14base_src_unpack() { 56base_src_unpack() {
15 57 debug-print-function $FUNCNAME "$@"
16 while [ "$1" ]; do 58
17 59 pushd "${WORKDIR}" > /dev/null
18 case $1 in 60
19 unpack) 61 if [[ $(type -t unpacker_src_unpack) == "function" ]] ; then
62 unpacker_src_unpack
63 elif [[ -n ${A} ]] ; then
20 unpack ${A} 64 unpack ${A}
21 ;; 65 fi
22 all) 66 has src_prepare ${BASE_EXPF} || base_src_prepare
23 base_src_unpack unpack 67
24 ;; 68 popd > /dev/null
25 esac
26
27 shift
28 done
29
30} 69}
31 70
71# @FUNCTION: base_src_prepare
72# @DESCRIPTION:
73# The base src_prepare function, which is exported
74# EAPI is greater or equal to 2. Here the PATCHES array is evaluated.
32base_src_compile() { 75base_src_prepare() {
33 76 debug-print-function $FUNCNAME "$@"
34 while [ "$1" ]; do 77 debug-print "$FUNCNAME: PATCHES=$PATCHES"
35 78
36 case $1 in 79 local patches_failed=0
37 configure) 80
38 configure || die 81 pushd "${S}" > /dev/null
39 ;; 82 if [[ "$(declare -p PATCHES 2>/dev/null 2>&1)" == "declare -a"* ]]; then
40 make) 83 for x in "${PATCHES[@]}"; do
41 make || die 84 debug-print "$FUNCNAME: applying patch from ${x}"
42 ;; 85 if [[ -d "${x}" ]]; then
43 all) 86 # Use standardized names and locations with bulk patching
44 base_src_compile configure make 87 # Patch directory is ${WORKDIR}/patch
45 ;; 88 # See epatch() in eutils.eclass for more documentation
46 esac 89 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
47 90
48 shift 91 # in order to preserve normal EPATCH_SOURCE value that can
49 done 92 # be used other way than with base eclass store in local
50 93 # variable and restore later
94 oldval=${EPATCH_SOURCE}
95 EPATCH_SOURCE=${x}
96 EPATCH_FORCE=yes
97 epatch
98 EPATCH_SOURCE=${oldval}
99 elif [[ -f "${x}" ]]; then
100 epatch "${x}"
101 else
102 ewarn "QA: File or directory \"${x}\" does not exist."
103 ewarn "QA: Check your PATCHES array or add missing file/directory."
104 patches_failed=1
105 fi
106 done
107 [[ ${patches_failed} -eq 1 ]] && die "Some patches failed. See above messages."
108 else
109 for x in ${PATCHES}; do
110 debug-print "$FUNCNAME: patching from ${x}"
111 epatch "${x}"
112 done
113 fi
114
115 # Apply user patches
116 debug-print "$FUNCNAME: applying user patches"
117 epatch_user
118
119 popd > /dev/null
51} 120}
52 121
53base_src_install() { 122# @FUNCTION: base_src_configure
123# @DESCRIPTION:
124# The base src_configure function, which is exported when
125# EAPI is greater or equal to 2. Runs basic econf.
126base_src_configure() {
127 debug-print-function $FUNCNAME "$@"
54 128
55 while [ "$1" ]; do 129 # there is no pushd ${S} so we can override its place where to run
56 130 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf "$@"
57 case $1 in
58 make)
59 make DESTDIR=${D} install || die
60 ;;
61 all)
62 base_src_install make
63 ;;
64 esac
65
66 shift
67 done
68
69} 131}
70 132
71EXPORT_FUNCTIONS 133# @FUNCTION: base_src_compile
134# @DESCRIPTION:
135# The base src_compile function, calls src_configure with
136# EAPI older than 2.
137base_src_compile() {
138 debug-print-function $FUNCNAME "$@"
72 139
140 has src_configure ${BASE_EXPF} || base_src_configure
141 base_src_make "$@"
142}
143
144# @FUNCTION: base_src_make
145# @DESCRIPTION:
146# Actual function that runs emake command.
147base_src_make() {
148 debug-print-function $FUNCNAME "$@"
149
150 if [[ -f Makefile || -f GNUmakefile || -f makefile ]]; then
151 emake "$@" || die "died running emake, $FUNCNAME"
152 fi
153}
154
155# @FUNCTION: base_src_install
156# @DESCRIPTION:
157# The base src_install function. Runs make install and
158# installs documents and html documents from DOCS and HTML_DOCS
159# arrays.
160base_src_install() {
161 debug-print-function $FUNCNAME "$@"
162
163 emake DESTDIR="${D}" "$@" install || die "died running make install, $FUNCNAME"
164 base_src_install_docs
165}
166
167# @FUNCTION: base_src_install_docs
168# @DESCRIPTION:
169# Actual function that install documentation from
170# DOCS and HTML_DOCS arrays.
171base_src_install_docs() {
172 debug-print-function $FUNCNAME "$@"
173
174 local x
175
176 pushd "${S}" > /dev/null
177
178 if [[ "$(declare -p DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
179 for x in "${DOCS[@]}"; do
180 debug-print "$FUNCNAME: docs: creating document from ${x}"
181 dodoc "${x}" || die "dodoc failed"
182 done
183 fi
184 if [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
185 for x in "${HTML_DOCS[@]}"; do
186 debug-print "$FUNCNAME: docs: creating html document from ${x}"
187 dohtml -r "${x}" || die "dohtml failed"
188 done
189 fi
190
191 popd > /dev/null
192}
193
194fi

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.58

  ViewVC Help
Powered by ViewVC 1.1.20