1 |
# Copyright 1999-2012 Gentoo Foundation |
2 |
# Distributed under the terms of the GNU General Public License v2 |
3 |
# $Header: /var/cvsroot/gentoo-x86/eclass/bzr.eclass,v 1.18 2012/07/18 15:12:54 ulm Exp $ |
4 |
# |
5 |
# @ECLASS: bzr.eclass |
6 |
# @MAINTAINER: |
7 |
# Emacs team <emacs@gentoo.org> |
8 |
# Bazaar team <bazaar@gentoo.org> |
9 |
# @AUTHOR: |
10 |
# Jorge Manuel B. S. Vicetto <jmbsvicetto@gentoo.org> |
11 |
# Mark Lee <bzr-gentoo-overlay@lazymalevolence.com> |
12 |
# Ulrich Müller <ulm@gentoo.org> |
13 |
# Christian Faulhammer <fauli@gentoo.org> |
14 |
# @BLURB: generic fetching functions for the Bazaar VCS |
15 |
# @DESCRIPTION: |
16 |
# The bzr.eclass provides functions to fetch, unpack, patch, and |
17 |
# bootstrap sources from repositories of the Bazaar distributed version |
18 |
# control system. The eclass was originally derived from git.eclass. |
19 |
# |
20 |
# Note: Just set EBZR_REPO_URI to the URI of the branch and src_unpack() |
21 |
# of this eclass will export the branch to ${WORKDIR}/${P}. |
22 |
|
23 |
inherit eutils |
24 |
|
25 |
EBZR="bzr.eclass" |
26 |
|
27 |
case "${EAPI:-0}" in |
28 |
0|1) EXPORT_FUNCTIONS src_unpack ;; |
29 |
*) EXPORT_FUNCTIONS src_unpack src_prepare ;; |
30 |
esac |
31 |
|
32 |
DEPEND=">=dev-vcs/bzr-2.0.1" |
33 |
case "${EAPI:-0}" in |
34 |
0|1) ;; |
35 |
*) [[ ${EBZR_REPO_URI%%:*} = sftp ]] \ |
36 |
&& DEPEND=">=dev-vcs/bzr-2.0.1[sftp]" ;; |
37 |
esac |
38 |
|
39 |
# @ECLASS-VARIABLE: EBZR_STORE_DIR |
40 |
# @DESCRIPTION: |
41 |
# The directory to store all fetched Bazaar live sources. |
42 |
: ${EBZR_STORE_DIR:=${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}/bzr-src} |
43 |
|
44 |
# @ECLASS-VARIABLE: EBZR_INIT_REPO_CMD |
45 |
# @DESCRIPTION: |
46 |
# The Bazaar command to initialise a shared repository. |
47 |
: ${EBZR_INIT_REPO_CMD:="bzr init-repository --no-trees"} |
48 |
|
49 |
# @ECLASS-VARIABLE: EBZR_FETCH_CMD |
50 |
# @DESCRIPTION: |
51 |
# The Bazaar command to fetch the sources. |
52 |
: ${EBZR_FETCH_CMD:="bzr branch --no-tree"} |
53 |
|
54 |
# @ECLASS-VARIABLE: EBZR_UPDATE_CMD |
55 |
# @DESCRIPTION: |
56 |
# The Bazaar command to update the sources. |
57 |
: ${EBZR_UPDATE_CMD:="bzr pull"} |
58 |
|
59 |
# @ECLASS-VARIABLE: EBZR_EXPORT_CMD |
60 |
# @DESCRIPTION: |
61 |
# The Bazaar command to export a branch. |
62 |
: ${EBZR_EXPORT_CMD:="bzr export"} |
63 |
|
64 |
# @ECLASS-VARIABLE: EBZR_CHECKOUT_CMD |
65 |
# @DESCRIPTION: |
66 |
# The Bazaar command to checkout a branch. |
67 |
: ${EBZR_CHECKOUT_CMD:="bzr checkout --lightweight -q"} |
68 |
|
69 |
# @ECLASS-VARIABLE: EBZR_REVNO_CMD |
70 |
# @DESCRIPTION: |
71 |
# The Bazaar command to list a revision number of the branch. |
72 |
: ${EBZR_REVNO_CMD:="bzr revno"} |
73 |
|
74 |
# @ECLASS-VARIABLE: EBZR_OPTIONS |
75 |
# @DEFAULT_UNSET |
76 |
# @DESCRIPTION: |
77 |
# The options passed to the fetch and update commands. |
78 |
|
79 |
# @ECLASS-VARIABLE: EBZR_REPO_URI |
80 |
# @DEFAULT_UNSET |
81 |
# @REQUIRED |
82 |
# @DESCRIPTION: |
83 |
# The repository URI for the source package. |
84 |
# |
85 |
# Note: If the ebuild uses an sftp:// URI, then in EAPI 0 or 1 it must |
86 |
# make sure that dev-vcs/bzr was built with USE="sftp". In EAPI 2 or |
87 |
# later, the eclass will depend on dev-vcs/bzr[sftp]. |
88 |
|
89 |
# @ECLASS-VARIABLE: EBZR_INITIAL_URI |
90 |
# @DEFAULT_UNSET |
91 |
# @DESCRIPTION: |
92 |
# The URI used for initial branching of the source repository. If this |
93 |
# variable is set, the initial branch will be cloned from the location |
94 |
# specified, followed by a pull from ${EBZR_REPO_URI}. This is intended |
95 |
# for special cases, e.g. when download from the original repository is |
96 |
# slow, but a fast mirror exists but may be out of date. |
97 |
# |
98 |
# Normally, this variable needs not be set. |
99 |
|
100 |
# @ECLASS-VARIABLE: EBZR_BOOTSTRAP |
101 |
# @DEFAULT_UNSET |
102 |
# @DESCRIPTION: |
103 |
# Bootstrap script or command like autogen.sh or etc. |
104 |
|
105 |
# @ECLASS-VARIABLE: EBZR_PATCHES |
106 |
# @DEFAULT_UNSET |
107 |
# @DESCRIPTION: |
108 |
# bzr.eclass can apply patches in bzr_bootstrap(). You can use regular |
109 |
# expressions in this variable like *.diff or *.patch and the like. |
110 |
# Note: These patches will be applied before EBZR_BOOTSTRAP is processed. |
111 |
# |
112 |
# Patches are searched both in ${PWD} and ${FILESDIR}. If not found in |
113 |
# either location, the installation dies. |
114 |
|
115 |
# @ECLASS-VARIABLE: EBZR_PROJECT |
116 |
# @DESCRIPTION: |
117 |
# The project name of your ebuild. Normally, the branch will be stored |
118 |
# in the ${EBZR_STORE_DIR}/${EBZR_PROJECT} directory. |
119 |
# |
120 |
# If EBZR_BRANCH is set (see below), then a shared repository will be |
121 |
# created in that directory, and the branch will be located in |
122 |
# ${EBZR_STORE_DIR}/${EBZR_PROJECT}/${EBZR_BRANCH}. |
123 |
: ${EBZR_PROJECT:=${PN}} |
124 |
|
125 |
# @ECLASS-VARIABLE: EBZR_BRANCH |
126 |
# @DEFAULT_UNSET |
127 |
# @DESCRIPTION: |
128 |
# The directory where to store the branch within a shared repository, |
129 |
# relative to ${EBZR_STORE_DIR}/${EBZR_PROJECT}. |
130 |
# |
131 |
# This variable should be set if there are several live ebuilds for |
132 |
# different branches of the same upstream project. The branches can |
133 |
# then share the same repository in EBZR_PROJECT, which will save both |
134 |
# data traffic volume and disk space. |
135 |
# |
136 |
# If there is only a live ebuild for one single branch, EBZR_BRANCH |
137 |
# needs not be set. In this case, the branch will be stored in a |
138 |
# stand-alone repository directly in EBZR_PROJECT. |
139 |
|
140 |
# @ECLASS-VARIABLE: EBZR_REVISION |
141 |
# @DEFAULT_UNSET |
142 |
# @DESCRIPTION: |
143 |
# Revision to fetch, defaults to the latest |
144 |
# (see http://bazaar-vcs.org/BzrRevisionSpec or bzr help revisionspec). |
145 |
|
146 |
# @ECLASS-VARIABLE: EBZR_OFFLINE |
147 |
# @DESCRIPTION: |
148 |
# Set this variable to a non-empty value to disable automatic updating |
149 |
# of a bzr source tree. This is intended to be set outside the ebuild |
150 |
# by users. |
151 |
: ${EBZR_OFFLINE=${EVCS_OFFLINE}} |
152 |
|
153 |
# @ECLASS-VARIABLE: EBZR_WORKDIR_CHECKOUT |
154 |
# @DEFAULT_UNSET |
155 |
# @DESCRIPTION: |
156 |
# If this variable is set to a non-empty value, EBZR_CHECKOUT_CMD will |
157 |
# be used instead of EBZR_EXPORT_CMD to copy the sources to WORKDIR. |
158 |
|
159 |
# @FUNCTION: bzr_initial_fetch |
160 |
# @USAGE: <repository URI> <branch directory> |
161 |
# @DESCRIPTION: |
162 |
# Internal function, retrieves the source code from a repository for the |
163 |
# first time, using ${EBZR_FETCH_CMD}. |
164 |
bzr_initial_fetch() { |
165 |
local repo_uri=$1 branch_dir=$2 |
166 |
|
167 |
if [[ -n "${EBZR_OFFLINE}" ]]; then |
168 |
ewarn "EBZR_OFFLINE cannot be used when there is no local branch yet." |
169 |
fi |
170 |
|
171 |
# fetch branch |
172 |
einfo "bzr branch start -->" |
173 |
einfo " repository: ${repo_uri} => ${branch_dir}" |
174 |
|
175 |
${EBZR_FETCH_CMD} ${EBZR_OPTIONS} "${repo_uri}" "${branch_dir}" \ |
176 |
|| die "${EBZR}: can't branch from ${repo_uri}" |
177 |
} |
178 |
|
179 |
# @FUNCTION: bzr_update |
180 |
# @USAGE: <repository URI> <branch directory> |
181 |
# @DESCRIPTION: |
182 |
# Internal function, updates the source code from a repository, using |
183 |
# ${EBZR_UPDATE_CMD}. |
184 |
bzr_update() { |
185 |
local repo_uri=$1 branch_dir=$2 |
186 |
|
187 |
if [[ -n "${EBZR_OFFLINE}" ]]; then |
188 |
einfo "skipping bzr pull -->" |
189 |
einfo " repository: ${repo_uri}" |
190 |
else |
191 |
# update branch |
192 |
einfo "bzr pull start -->" |
193 |
einfo " repository: ${repo_uri}" |
194 |
|
195 |
pushd "${branch_dir}" > /dev/null \ |
196 |
|| die "${EBZR}: can't chdir to ${branch_dir}" |
197 |
${EBZR_UPDATE_CMD} ${EBZR_OPTIONS} "${repo_uri}" \ |
198 |
|| die "${EBZR}: can't pull from ${repo_uri}" |
199 |
popd > /dev/null |
200 |
fi |
201 |
} |
202 |
|
203 |
# @FUNCTION: bzr_fetch |
204 |
# @DESCRIPTION: |
205 |
# Wrapper function to fetch sources from a Bazaar repository with |
206 |
# bzr branch or bzr pull, depending on whether there is an existing |
207 |
# working copy. |
208 |
bzr_fetch() { |
209 |
local repo_dir branch_dir |
210 |
local save_sandbox_write=${SANDBOX_WRITE} |
211 |
|
212 |
[[ -n ${EBZR_REPO_URI} ]] || die "${EBZR}: EBZR_REPO_URI is empty" |
213 |
|
214 |
if [[ ! -d ${EBZR_STORE_DIR} ]] ; then |
215 |
addwrite / |
216 |
mkdir -p "${EBZR_STORE_DIR}" \ |
217 |
|| die "${EBZR}: can't mkdir ${EBZR_STORE_DIR}" |
218 |
SANDBOX_WRITE=${save_sandbox_write} |
219 |
fi |
220 |
|
221 |
pushd "${EBZR_STORE_DIR}" > /dev/null \ |
222 |
|| die "${EBZR}: can't chdir to ${EBZR_STORE_DIR}" |
223 |
|
224 |
repo_dir=${EBZR_STORE_DIR}/${EBZR_PROJECT} |
225 |
branch_dir=${repo_dir}${EBZR_BRANCH:+/${EBZR_BRANCH}} |
226 |
|
227 |
addwrite "${EBZR_STORE_DIR}" |
228 |
|
229 |
if [[ ! -d ${branch_dir}/.bzr ]]; then |
230 |
if [[ ${repo_dir} != "${branch_dir}" && ! -d ${repo_dir}/.bzr ]]; then |
231 |
einfo "creating shared bzr repository: ${repo_dir}" |
232 |
${EBZR_INIT_REPO_CMD} "${repo_dir}" \ |
233 |
|| die "${EBZR}: can't create shared repository" |
234 |
fi |
235 |
|
236 |
if [[ -z ${EBZR_INITIAL_URI} ]]; then |
237 |
bzr_initial_fetch "${EBZR_REPO_URI}" "${branch_dir}" |
238 |
else |
239 |
# Workaround for faster initial download. This clones the |
240 |
# branch from a fast server (which may be out of date), and |
241 |
# subsequently pulls from the slow original repository. |
242 |
bzr_initial_fetch "${EBZR_INITIAL_URI}" "${branch_dir}" |
243 |
if [[ ${EBZR_REPO_URI} != "${EBZR_INITIAL_URI}" ]]; then |
244 |
EBZR_UPDATE_CMD="${EBZR_UPDATE_CMD} --remember --overwrite" \ |
245 |
EBZR_OFFLINE="" \ |
246 |
bzr_update "${EBZR_REPO_URI}" "${branch_dir}" |
247 |
fi |
248 |
fi |
249 |
else |
250 |
bzr_update "${EBZR_REPO_URI}" "${branch_dir}" |
251 |
fi |
252 |
|
253 |
# Restore sandbox environment |
254 |
SANDBOX_WRITE=${save_sandbox_write} |
255 |
|
256 |
cd "${branch_dir}" || die "${EBZR}: can't chdir to ${branch_dir}" |
257 |
|
258 |
# Save revision number in environment. #311101 |
259 |
export EBZR_REVNO=$(${EBZR_REVNO_CMD}) |
260 |
|
261 |
if [[ -n ${EBZR_WORKDIR_CHECKOUT} ]]; then |
262 |
einfo "checking out ..." |
263 |
${EBZR_CHECKOUT_CMD} ${EBZR_REVISION:+-r ${EBZR_REVISION}} \ |
264 |
. "${WORKDIR}/${P}" || die "${EBZR}: checkout failed" |
265 |
else |
266 |
einfo "exporting ..." |
267 |
${EBZR_EXPORT_CMD} ${EBZR_REVISION:+-r ${EBZR_REVISION}} \ |
268 |
"${WORKDIR}/${P}" . || die "${EBZR}: export failed" |
269 |
fi |
270 |
einfo "revision ${EBZR_REVISION:-${EBZR_REVNO}} is now in ${WORKDIR}/${P}" |
271 |
|
272 |
popd > /dev/null |
273 |
} |
274 |
|
275 |
# @FUNCTION: bzr_bootstrap |
276 |
# @DESCRIPTION: |
277 |
# Apply patches in ${EBZR_PATCHES} and run ${EBZR_BOOTSTRAP} if specified. |
278 |
bzr_bootstrap() { |
279 |
local patch lpatch |
280 |
|
281 |
pushd "${S}" > /dev/null || die "${EBZR}: can't chdir to ${S}" |
282 |
|
283 |
if [[ -n ${EBZR_PATCHES} ]] ; then |
284 |
einfo "apply patches -->" |
285 |
|
286 |
for patch in ${EBZR_PATCHES} ; do |
287 |
if [[ -f ${patch} ]] ; then |
288 |
epatch ${patch} |
289 |
else |
290 |
# This loop takes care of wildcarded patches given via |
291 |
# EBZR_PATCHES in an ebuild |
292 |
for lpatch in "${FILESDIR}"/${patch} ; do |
293 |
if [[ -f ${lpatch} ]] ; then |
294 |
epatch ${lpatch} |
295 |
else |
296 |
die "${EBZR}: ${patch} is not found" |
297 |
fi |
298 |
done |
299 |
fi |
300 |
done |
301 |
fi |
302 |
|
303 |
if [[ -n ${EBZR_BOOTSTRAP} ]] ; then |
304 |
einfo "begin bootstrap -->" |
305 |
|
306 |
if [[ -f ${EBZR_BOOTSTRAP} ]] && [[ -x ${EBZR_BOOTSTRAP} ]] ; then |
307 |
einfo " bootstrap with a file: ${EBZR_BOOTSTRAP}" |
308 |
"./${EBZR_BOOTSTRAP}" \ |
309 |
|| die "${EBZR}: can't execute EBZR_BOOTSTRAP" |
310 |
else |
311 |
einfo " bootstrap with commands: ${EBZR_BOOTSTRAP}" |
312 |
"${EBZR_BOOTSTRAP}" \ |
313 |
|| die "${EBZR}: can't eval EBZR_BOOTSTRAP" |
314 |
fi |
315 |
fi |
316 |
|
317 |
popd > /dev/null |
318 |
} |
319 |
|
320 |
# @FUNCTION: bzr_src_unpack |
321 |
# @DESCRIPTION: |
322 |
# Default src_unpack(), calls bzr_fetch. For EAPIs 0 and 1, also calls |
323 |
# bzr_src_prepare. |
324 |
bzr_src_unpack() { |
325 |
bzr_fetch |
326 |
case "${EAPI:-0}" in |
327 |
0|1) bzr_src_prepare ;; |
328 |
esac |
329 |
} |
330 |
|
331 |
# @FUNCTION: bzr_src_prepare |
332 |
# @DESCRIPTION: |
333 |
# Default src_prepare(), calls bzr_bootstrap. |
334 |
bzr_src_prepare() { |
335 |
bzr_bootstrap |
336 |
} |