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

Diff of /eclass/base.eclass

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

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

Legend:
Removed from v.1.34  
changed lines
  Added in v.1.56

  ViewVC Help
Powered by ViewVC 1.1.20