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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.42 - (show annotations) (download)
Tue Feb 23 00:43:54 2010 UTC (4 years, 9 months ago) by abcd
Branch: MAIN
Changes since 1.41: +69 -33 lines
Speed up code for the common case where there are no submodules - if there are submodules, then you will need to set EGIT_HAS_SUBMODULES=true before inherit

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

  ViewVC Help
Powered by ViewVC 1.1.20