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

Diff of /eclass/base.eclass

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

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

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.41

  ViewVC Help
Powered by ViewVC 1.1.20