/[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.58
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2012 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.58 2012/09/27 16:35:41 axs 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.
13# everything else inherits from here.
14 13
14if [[ ${___ECLASS_ONCE_BASE} != "recur -_+^+_- spank" ]] ; then
15___ECLASS_ONCE_BASE="recur -_+^+_- spank"
15 16
16inherit eutils 17inherit eutils
17 18
18DESCRIPTION="Based on the $ECLASS eclass" 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
19 51
20# @FUNCTION: base_src_unpack 52# @FUNCTION: base_src_unpack
21# @USAGE: [ unpack ] [ patch ] [ autopatch ] [ all ]
22# @DESCRIPTION: 53# @DESCRIPTION:
23# The base src_unpack function, which is exported. If no argument is given, 54# The base src_unpack function, which is exported.
24# "all" is assumed. 55# Calls also src_prepare with eapi older than 2.
25base_src_unpack() { 56base_src_unpack() {
57 debug-print-function $FUNCNAME "$@"
26 58
27 debug-print-function $FUNCNAME $* 59 pushd "${WORKDIR}" > /dev/null
28 [ -z "$1" ] && base_src_unpack all
29 60
30 cd "${WORKDIR}" 61 if [[ $(type -t unpacker_src_unpack) == "function" ]] ; then
62 unpacker_src_unpack
63 elif [[ -n ${A} ]] ; then
64 unpack ${A}
65 fi
66 has src_prepare ${BASE_EXPF} || base_src_prepare
31 67
32 while [ "$1" ]; do 68 popd > /dev/null
69}
33 70
34 case $1 in 71# @FUNCTION: base_src_prepare
35 unpack) 72# @DESCRIPTION:
36 debug-print-section unpack 73# The base src_prepare function, which is exported
37 unpack ${A} 74# EAPI is greater or equal to 2. Here the PATCHES array is evaluated.
38 ;; 75base_src_prepare() {
39 patch) 76 debug-print-function $FUNCNAME "$@"
40 debug-print-section patch 77 debug-print "$FUNCNAME: PATCHES=$PATCHES"
41 cd "${S}" 78
42 epatch "${FILESDIR}/${P}-gentoo.diff" 79 local patches_failed=0
43 ;; 80
44 autopatch) 81 pushd "${S}" > /dev/null
45 debug-print-section autopatch 82 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 83 for x in "${PATCHES[@]}"; do
50 debug-print "$FUNCNAME: autopatch: patching from ${x}" 84 debug-print "$FUNCNAME: applying patch from ${x}"
85 if [[ -d "${x}" ]]; then
86 # Use standardized names and locations with bulk patching
87 # Patch directory is ${WORKDIR}/patch
88 # See epatch() in eutils.eclass for more documentation
89 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
90
91 # in order to preserve normal EPATCH_SOURCE value that can
92 # be used other way than with base eclass store in local
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
51 epatch "${x}" 100 epatch "${x}"
52 done
53 else 101 else
54 for x in ${PATCHES} ${PATCHES1}; do 102 ewarn "QA: File or directory \"${x}\" does not exist."
55 debug-print "$FUNCNAME: autopatch: patching from ${x}" 103 ewarn "QA: Check your PATCHES array or add missing file/directory."
56 epatch "${x}" 104 patches_failed=1
57 done
58 fi 105 fi
59 ;; 106 done
60 all) 107 [[ ${patches_failed} -eq 1 ]] && die "Some patches failed. See above messages."
61 debug-print-section all 108 else
62 base_src_unpack unpack autopatch 109 for x in ${PATCHES}; do
63 ;; 110 debug-print "$FUNCNAME: patching from ${x}"
64 esac 111 epatch "${x}"
112 done
113 fi
65 114
66 shift 115 # Apply user patches
67 done 116 debug-print "$FUNCNAME: applying user patches"
117 epatch_user
68 118
119 popd > /dev/null
120}
121
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 "$@"
128
129 # there is no pushd ${S} so we can override its place where to run
130 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf "$@"
69} 131}
70 132
71# @FUNCTION: base_src_compile 133# @FUNCTION: base_src_compile
72# @USAGE: [ configure ] [ make ] [ all ]
73# @DESCRIPTION: 134# @DESCRIPTION:
74# The base src_compile function, which is exported. If no argument is given, 135# The base src_compile function, calls src_configure with
75# "all" is asasumed. 136# EAPI older than 2.
76base_src_compile() { 137base_src_compile() {
138 debug-print-function $FUNCNAME "$@"
77 139
78 debug-print-function $FUNCNAME $* 140 has src_configure ${BASE_EXPF} || base_src_configure
79 [ -z "$1" ] && base_src_compile all 141 base_src_make "$@"
142}
80 143
81 cd "${S}" 144# @FUNCTION: base_src_make
145# @DESCRIPTION:
146# Actual function that runs emake command.
147base_src_make() {
148 debug-print-function $FUNCNAME "$@"
82 149
83 while [ "$1" ]; do 150 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" 151 emake "$@" || die "died running emake, $FUNCNAME"
93 ;; 152 fi
94 all)
95 debug-print-section all
96 base_src_compile configure make
97 ;;
98 esac
99
100 shift
101 done
102
103} 153}
104 154
105# @FUNCTION: base_src_install 155# @FUNCTION: base_src_install
106# @USAGE: [ make ] [ all ]
107# @DESCRIPTION: 156# @DESCRIPTION:
108# The base src_install function, which is exported. If no argument is given, 157# The base src_install function. Runs make install and
109# "all" is assumed. 158# installs documents and html documents from DOCS and HTML_DOCS
159# arrays.
110base_src_install() { 160base_src_install() {
161 debug-print-function $FUNCNAME "$@"
111 162
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" 163 emake DESTDIR="${D}" "$@" install || die "died running make install, $FUNCNAME"
123 ;; 164 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} 165}
134 166
135EXPORT_FUNCTIONS src_unpack src_compile src_install 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.34  
changed lines
  Added in v.1.58

  ViewVC Help
Powered by ViewVC 1.1.20