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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.52 - (show annotations) (download)
Sat Mar 19 15:06:02 2011 UTC (3 years, 5 months ago) by scarabeus
Branch: MAIN
Changes since 1.51: +2 -2 lines
Fixup die case for eapi instead of invalid depend.

1 # Copyright 1999-2009 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/git.eclass,v 1.51 2011/02/02 19:26:53 ulm Exp $
4
5 # @ECLASS: git.eclass
6 # @MAINTAINER:
7 # Tomas Chvatal <scarabeus@gentoo.org>
8 # Donnie Berkholz <dberkholz@gentoo.org>
9 # @BLURB: This eclass provides functions for fetch and unpack git repositories
10 # @DESCRIPTION:
11 # The eclass is based on subversion eclass.
12 # If you use this eclass, the ${S} is ${WORKDIR}/${P}.
13 # It is necessary to define the EGIT_REPO_URI variable at least.
14 # @THANKS TO:
15 # Fernando J. Pereda <ferdy@gentoo.org>
16
17 inherit eutils
18
19 EGIT="git.eclass"
20
21 # We DEPEND on at least a bit recent git version
22 DEPEND=">=dev-vcs/git-1.6"
23
24 EXPORTED_FUNCTIONS="src_unpack"
25 case "${EAPI:-0}" in
26 4|3|2) EXPORTED_FUNCTIONS="${EXPORTED_FUNCTIONS} src_prepare" ;;
27 1|0) ;;
28 *) die "EAPI=${EAPI} is not supported" ;;
29 esac
30 EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS}
31
32 # define some nice defaults but only if nothing is set already
33 : ${HOMEPAGE:=http://git-scm.com/}
34
35 # @ECLASS-VARIABLE: EGIT_QUIET
36 # @DESCRIPTION:
37 # Set to non-empty value to supress some eclass messages.
38 : ${EGIT_QUIET:=${ESCM_QUIET}}
39
40 # @ECLASS-VARIABLE: EGIT_STORE_DIR
41 # @DESCRIPTION:
42 # Storage directory for git sources.
43 # Can be redefined.
44 : ${EGIT_STORE_DIR:="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/git-src"}
45
46 # @ECLASS-VARIABLE: EGIT_HAS_SUBMODULES
47 # @DESCRIPTION:
48 # Set this to non-empty value to enable submodule support (slower).
49 : ${EGIT_HAS_SUBMODULES:=}
50
51 # @ECLASS-VARIABLE: EGIT_FETCH_CMD
52 # @DESCRIPTION:
53 # Command for cloning the repository.
54 : ${EGIT_FETCH_CMD:="git clone"}
55
56 # @ECLASS-VARIABLE: EGIT_UPDATE_CMD
57 # @DESCRIPTION:
58 # Git fetch command.
59 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
60 EGIT_UPDATE_CMD="git pull -f -u"
61 else
62 EGIT_UPDATE_CMD="git fetch -f -u"
63 fi
64
65 # @ECLASS-VARIABLE: EGIT_DIFFSTAT_CMD
66 # @DESCRIPTION:
67 # Git command for diffstat.
68 EGIT_DIFFSTAT_CMD="git --no-pager diff --stat"
69
70 # @ECLASS-VARIABLE: EGIT_OPTIONS
71 # @DESCRIPTION:
72 # This variable value is passed to clone and fetch.
73 : ${EGIT_OPTIONS:=}
74
75 # @ECLASS-VARIABLE: EGIT_MASTER
76 # @DESCRIPTION:
77 # Variable for specifying master branch.
78 # Usefull when upstream don't have master branch.
79 : ${EGIT_MASTER:=master}
80
81 # @ECLASS-VARIABLE: EGIT_REPO_URI
82 # @DESCRIPTION:
83 # URI for the repository
84 # e.g. http://foo, git://bar
85 # Supported protocols:
86 # http://
87 # https://
88 # git://
89 # git+ssh://
90 # rsync://
91 # ssh://
92 eval X="\$${PN//[-+]/_}_LIVE_REPO"
93 if [[ ${X} = "" ]]; then
94 : ${EGIT_REPO_URI:=}
95 else
96 EGIT_REPO_URI="${X}"
97 fi
98 # @ECLASS-VARIABLE: EGIT_PROJECT
99 # @DESCRIPTION:
100 # Project name, it must be unique across EGIT_STORE_DIR.
101 # Git eclass will check out the git repository into ${EGIT_STORE_DIR}/${EGIT_PROJECT}/${EGIT_REPO_URI##*/}
102 # Default is ${PN}.
103 : ${EGIT_PROJECT:=${PN}}
104
105 # @ECLASS-VARIABLE: EGIT_BOOTSTRAP
106 # @DESCRIPTION:
107 # bootstrap script or command like autogen.sh or etc...
108 : ${EGIT_BOOTSTRAP:=}
109
110 # @ECLASS-VARIABLE: EGIT_OFFLINE
111 # @DESCRIPTION:
112 # Set this variable to a non-empty value to disable the automatic updating of
113 # an GIT source tree. This is intended to be set outside the git source
114 # tree by users.
115 : ${EGIT_OFFLINE:=${ESCM_OFFLINE}}
116
117 # @ECLASS-VARIABLE: EGIT_PATCHES
118 # @DESCRIPTION:
119 # Similar to PATCHES array from base.eclass
120 # Only difference is that this patches are applied before bootstrap.
121 # Please take note that this variable should be bash array.
122
123 # @ECLASS-VARIABLE: EGIT_BRANCH
124 # @DESCRIPTION:
125 # git eclass can fetch any branch in git_fetch().
126 eval X="\$${PN//[-+]/_}_LIVE_BRANCH"
127 if [[ "${X}" = "" ]]; then
128 : ${EGIT_BRANCH:=master}
129 else
130 EGIT_BRANCH="${X}"
131 fi
132
133 # @ECLASS-VARIABLE: EGIT_COMMIT
134 # @DESCRIPTION:
135 # git eclass can checkout any commit.
136 eval X="\$${PN//[-+]/_}_LIVE_COMMIT"
137 if [[ "${X}" = "" ]]; then
138 : ${EGIT_COMMIT:=${EGIT_BRANCH}}
139 else
140 EGIT_COMMIT="${X}"
141 fi
142
143 # @ECLASS-VARIABLE: EGIT_REPACK
144 # @DESCRIPTION:
145 # Set to non-empty value to repack objects to save disk space. However this can
146 # take a long time with VERY big repositories.
147 : ${EGIT_REPACK:=}
148
149 # @ECLASS-VARIABLE: EGIT_PRUNE
150 # @DESCRIPTION:
151 # Set to non-empty value to prune loose objects on each fetch. This is useful
152 # if upstream rewinds and rebases branches often.
153 : ${EGIT_PRUNE:=}
154
155 # @FUNCTION: git_submodules
156 # @DESCRIPTION:
157 # Internal function wrapping the submodule initialisation and update
158 git_submodules() {
159 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
160 debug-print "git submodule init"
161 git submodule init
162 debug-print "git submodule sync"
163 git submodule sync
164 debug-print "git submodule update"
165 git submodule update
166 fi
167 }
168
169 # @FUNCTION: git_branch
170 # @DESCRIPTION:
171 # Internal function that changes branch for the repo based on EGIT_TREE and
172 # EGIT_BRANCH variables.
173 git_branch() {
174 local branchname=branch-${EGIT_BRANCH} src=origin/${EGIT_BRANCH}
175 if [[ "${EGIT_COMMIT}" != "${EGIT_BRANCH}" ]]; then
176 branchname=tree-${EGIT_COMMIT}
177 src=${EGIT_COMMIT}
178 fi
179 debug-print "git checkout -b ${branchname} ${src}"
180 git checkout -b ${branchname} ${src} &> /dev/null
181
182 unset branchname src
183 }
184
185 # @FUNCTION: git_fetch
186 # @DESCRIPTION:
187 # Gets repository from EGIT_REPO_URI and store it in specified EGIT_STORE_DIR
188 git_fetch() {
189 debug-print-function ${FUNCNAME} "$@"
190
191 local GIT_DIR EGIT_CLONE_DIR oldsha1 cursha1 extra_clone_opts upstream_branch
192 [[ -z ${EGIT_HAS_SUBMODULES} ]] && export GIT_DIR
193
194 # choose if user wants elog or just einfo.
195 if [[ -n ${EGIT_QUIET} ]]; then
196 elogcmd="einfo"
197 else
198 elogcmd="elog"
199 fi
200
201 # If we have same branch and the tree we can do --depth 1 clone
202 # which outputs into really smaller data transfers.
203 # Sadly we can do shallow copy for now because quite a few packages need .git
204 # folder.
205 #[[ ${EGIT_COMMIT} = ${EGIT_BRANCH} ]] && \
206 # EGIT_FETCH_CMD="${EGIT_FETCH_CMD} --depth 1"
207 if [[ -n ${EGIT_TREE} ]] ; then
208 EGIT_COMMIT=${EGIT_TREE}
209 ewarn "QA: Usage of deprecated EGIT_TREE variable detected."
210 ewarn "QA: Use EGIT_COMMIT variable instead."
211 fi
212
213 # EGIT_REPO_URI is empty.
214 [[ -z ${EGIT_REPO_URI} ]] && die "${EGIT}: EGIT_REPO_URI is empty."
215
216 # check for the protocol or pull from a local repo.
217 if [[ -z ${EGIT_REPO_URI%%:*} ]] ; then
218 case ${EGIT_REPO_URI%%:*} in
219 git*|http|https|rsync|ssh) ;;
220 *) die "${EGIT}: protocol for fetch from "${EGIT_REPO_URI%:*}" is not yet implemented in eclass." ;;
221 esac
222 fi
223
224 # initial clone, we have to create master git storage directory and play
225 # nicely with sandbox
226 if [[ ! -d ${EGIT_STORE_DIR} ]] ; then
227 debug-print "${FUNCNAME}: initial clone. creating git directory"
228 addwrite /
229 mkdir -p "${EGIT_STORE_DIR}" \
230 || die "${EGIT}: can't mkdir ${EGIT_STORE_DIR}."
231 export SANDBOX_WRITE="${SANDBOX_WRITE%%:/}"
232 fi
233
234 cd -P "${EGIT_STORE_DIR}" || die "${EGIT}: can't chdir to ${EGIT_STORE_DIR}"
235 EGIT_STORE_DIR=${PWD}
236
237 # allow writing into EGIT_STORE_DIR
238 addwrite "${EGIT_STORE_DIR}"
239
240 [[ -z ${EGIT_REPO_URI##*/} ]] && EGIT_REPO_URI="${EGIT_REPO_URI%/}"
241 EGIT_CLONE_DIR="${EGIT_PROJECT}"
242
243 debug-print "${FUNCNAME}: EGIT_OPTIONS = \"${EGIT_OPTIONS}\""
244
245 GIT_DIR="${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}"
246 # we also have to remove all shallow copied repositories
247 # and fetch them again
248 if [[ -e "${GIT_DIR}/shallow" ]]; then
249 rm -rf "${GIT_DIR}"
250 einfo "The ${EGIT_CLONE_DIR} was shallow copy. Refetching."
251 fi
252 # repack from bare copy to normal one
253 if [[ -n ${EGIT_HAS_SUBMODULES} ]] && [[ -d ${GIT_DIR} && ! -d ${GIT_DIR}/.git ]]; then
254 rm -rf "${GIT_DIR}"
255 einfo "The ${EGIT_CLONE_DIR} was bare copy. Refetching."
256 fi
257 if [[ -z ${EGIT_HAS_SUBMODULES} ]] && [[ -d ${GIT_DIR} && -d ${GIT_DIR}/.git ]]; then
258 rm -rf "${GIT_DIR}"
259 einfo "The ${EGIT_CLONE_DIR} was not a bare copy. Refetching."
260 fi
261
262 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
263 upstream_branch=origin/${EGIT_BRANCH}
264 else
265 upstream_branch=${EGIT_BRANCH}
266 extra_clone_opts=--bare
267 fi
268
269 if [[ ! -d ${GIT_DIR} ]] ; then
270 # first clone
271 ${elogcmd} "GIT NEW clone -->"
272 ${elogcmd} " repository: ${EGIT_REPO_URI}"
273
274 debug-print "${EGIT_FETCH_CMD} ${extra_clone_opts} ${EGIT_OPTIONS} \"${EGIT_REPO_URI}\" ${GIT_DIR}"
275 ${EGIT_FETCH_CMD} ${extra_clone_opts} ${EGIT_OPTIONS} "${EGIT_REPO_URI}" ${GIT_DIR} \
276 || die "${EGIT}: can't fetch from ${EGIT_REPO_URI}."
277
278 pushd "${GIT_DIR}" &> /dev/null
279 cursha1=$(git rev-parse ${upstream_branch})
280 ${elogcmd} " at the commit: ${cursha1}"
281
282 git_submodules
283 popd &> /dev/null
284 elif [[ -n ${EGIT_OFFLINE} ]] ; then
285 pushd "${GIT_DIR}" &> /dev/null
286 cursha1=$(git rev-parse ${upstream_branch})
287 ${elogcmd} "GIT offline update -->"
288 ${elogcmd} " repository: ${EGIT_REPO_URI}"
289 ${elogcmd} " at the commit: ${cursha1}"
290 popd &> /dev/null
291 else
292 pushd "${GIT_DIR}" &> /dev/null
293 # Git urls might change, so unconditionally set it here
294 git config remote.origin.url "${EGIT_REPO_URI}"
295
296 # fetch updates
297 ${elogcmd} "GIT update -->"
298 ${elogcmd} " repository: ${EGIT_REPO_URI}"
299
300 oldsha1=$(git rev-parse ${upstream_branch})
301
302 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
303 debug-print "${EGIT_UPDATE_CMD} ${EGIT_OPTIONS}"
304 # fix branching
305 git checkout ${EGIT_MASTER}
306 for x in $(git branch |grep -v "* ${EGIT_MASTER}" |tr '\n' ' '); do
307 git branch -D ${x}
308 done
309 ${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} \
310 || die "${EGIT}: can't update from ${EGIT_REPO_URI}."
311 else
312 debug-print "${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} origin ${EGIT_BRANCH}:${EGIT_BRANCH}"
313 ${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} origin ${EGIT_BRANCH}:${EGIT_BRANCH} \
314 || die "${EGIT}: can't update from ${EGIT_REPO_URI}."
315 fi
316
317 git_submodules
318 cursha1=$(git rev-parse ${upstream_branch})
319
320 # write out message based on the revisions
321 if [[ "${oldsha1}" != "${cursha1}" ]]; then
322 ${elogcmd} " updating from commit: ${oldsha1}"
323 ${elogcmd} " to commit: ${cursha1}"
324 else
325 ${elogcmd} " at the commit: ${cursha1}"
326 # @ECLASS_VARIABLE: LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED
327 # @DESCRIPTION:
328 # If this variable is set to TRUE in make.conf or somewhere in
329 # enviroment the package will fail if there is no update, thus in
330 # combination with --keep-going it would lead in not-updating
331 # pakcages that are up-to-date.
332 # TODO: this can lead to issues if more projects/packages use same repo
333 [[ ${LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED} = true ]] && \
334 debug-print "${FUNCNAME}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping." && \
335 die "${EGIT}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping."
336 fi
337 ${EGIT_DIFFSTAT_CMD} ${oldsha1}..${upstream_branch}
338 popd &> /dev/null
339 fi
340
341 pushd "${GIT_DIR}" &> /dev/null
342 if [[ -n ${EGIT_REPACK} ]] || [[ -n ${EGIT_PRUNE} ]]; then
343 ebegin "Garbage collecting the repository"
344 local args
345 [[ -n ${EGIT_PRUNE} ]] && args='--prune'
346 git gc ${args}
347 eend $?
348 fi
349 popd &> /dev/null
350
351 # export the git version
352 export EGIT_VERSION="${cursha1}"
353
354 # log the repo state
355 [[ "${EGIT_COMMIT}" != "${EGIT_BRANCH}" ]] && ${elogcmd} " commit: ${EGIT_COMMIT}"
356 ${elogcmd} " branch: ${EGIT_BRANCH}"
357 ${elogcmd} " storage directory: \"${GIT_DIR}\""
358
359 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
360 pushd "${GIT_DIR}" &> /dev/null
361 debug-print "rsync -rlpgo . \"${S}\""
362 rsync -rlpgo . "${S}"
363 popd &> /dev/null
364 else
365 unset GIT_DIR
366 debug-print "git clone -l -s -n \"${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}\" \"${S}\""
367 git clone -l -s -n "${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}" "${S}"
368 fi
369
370 pushd "${S}" &> /dev/null
371 git_branch
372 # submodules always reqire net (thanks to branches changing)
373 [[ -z ${EGIT_OFFLINE} ]] && git_submodules
374 popd &> /dev/null
375
376 echo ">>> Unpacked to ${S}"
377 }
378
379 # @FUNCTION: git_bootstrap
380 # @DESCRIPTION:
381 # Runs bootstrap command if EGIT_BOOTSTRAP variable contains some value
382 # Remember that what ever gets to the EGIT_BOOTSTRAP variable gets evaled by bash.
383 git_bootstrap() {
384 debug-print-function ${FUNCNAME} "$@"
385
386 if [[ -n ${EGIT_BOOTSTRAP} ]] ; then
387 pushd "${S}" > /dev/null
388 einfo "Starting bootstrap"
389
390 if [[ -f ${EGIT_BOOTSTRAP} ]]; then
391 # we have file in the repo which we should execute
392 debug-print "$FUNCNAME: bootstraping with file \"${EGIT_BOOTSTRAP}\""
393
394 if [[ -x ${EGIT_BOOTSTRAP} ]]; then
395 eval "./${EGIT_BOOTSTRAP}" \
396 || die "${EGIT}: bootstrap script failed"
397 else
398 eerror "\"${EGIT_BOOTSTRAP}\" is not executable."
399 eerror "Report upstream, or bug ebuild maintainer to remove bootstrap command."
400 die "${EGIT}: \"${EGIT_BOOTSTRAP}\" is not executable."
401 fi
402 else
403 # we execute some system command
404 debug-print "$FUNCNAME: bootstraping with commands \"${EGIT_BOOTSTRAP}\""
405
406 eval "${EGIT_BOOTSTRAP}" \
407 || die "${EGIT}: bootstrap commands failed."
408
409 fi
410
411 einfo "Bootstrap finished"
412 popd > /dev/null
413 fi
414 }
415
416 # @FUNCTION: git_apply_patches
417 # @DESCRIPTION:
418 # Apply patches from EGIT_PATCHES bash array.
419 # Preferred is using the variable as bash array but for now it allows to write
420 # it also as normal space separated string list. (This part of code should be
421 # removed when all ebuilds get converted on bash array).
422 git_apply_patches() {
423 debug-print-function ${FUNCNAME} "$@"
424
425 pushd "${S}" > /dev/null
426 if [[ ${#EGIT_PATCHES[@]} -gt 1 ]] ; then
427 for i in "${EGIT_PATCHES[@]}"; do
428 debug-print "$FUNCNAME: git_autopatch: patching from ${i}"
429 epatch "${i}"
430 done
431 elif [[ -n ${EGIT_PATCHES} ]]; then
432 # no need for loop if space separated string is passed.
433 debug-print "$FUNCNAME: git_autopatch: patching from ${EGIT_PATCHES}"
434 epatch "${EGIT_PATCHES}"
435 fi
436
437 popd > /dev/null
438 }
439
440 # @FUNCTION: git_src_unpack
441 # @DESCRIPTION:
442 # src_upack function, calls src_prepare one if EAPI!=2.
443 git_src_unpack() {
444 debug-print-function ${FUNCNAME} "$@"
445
446 git_fetch || die "${EGIT}: unknown problem in git_fetch()."
447
448 has src_prepare ${EXPORTED_FUNCTIONS} || git_src_prepare
449 }
450
451 # @FUNCTION: git_src_prepare
452 # @DESCRIPTION:
453 # src_prepare function for git stuff. Patches, bootstrap...
454 git_src_prepare() {
455 debug-print-function ${FUNCNAME} "$@"
456
457 git_apply_patches
458 git_bootstrap
459 }

  ViewVC Help
Powered by ViewVC 1.1.20