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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.53 - (show annotations) (download)
Fri Apr 15 08:57:04 2011 UTC (3 years, 5 months ago) by hkbst
Branch: MAIN
Changes since 1.52: +17 -13 lines
add EGIT_UNPACK_DIR

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.48 2010/07/27 12:39:34 reavertm Exp $
4
5 # @ECLASS: git.eclass
6 # @MAINTAINER:
7 # Tomas Chvatal <scarabeus@gentoo.org>
8 # Donnie Berkholz <dberkholz@gentoo.org>
9 # @BLURB: Fetching and unpacking of git repositories
10 # @DESCRIPTION:
11 # The git eclass provides functions to fetch, patch and bootstrap
12 # software sources from git repositories and is based on the subversion eclass.
13 # It is necessary to define at least the EGIT_REPO_URI variable.
14 # @THANKS TO:
15 # Fernando J. Pereda <ferdy@gentoo.org>
16
17 inherit eutils
18
19 EGIT="git.eclass"
20
21 # We DEPEND on a not too ancient 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_UNPACK_DIR
47 # @DESCRIPTION:
48 # Directory to unpack git sources in.
49
50 # @ECLASS-VARIABLE: EGIT_HAS_SUBMODULES
51 # @DESCRIPTION:
52 # Set this to non-empty value to enable submodule support (slower).
53 : ${EGIT_HAS_SUBMODULES:=}
54
55 # @ECLASS-VARIABLE: EGIT_FETCH_CMD
56 # @DESCRIPTION:
57 # Command for cloning the repository.
58 : ${EGIT_FETCH_CMD:="git clone"}
59
60 # @ECLASS-VARIABLE: EGIT_UPDATE_CMD
61 # @DESCRIPTION:
62 # Git fetch command.
63 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
64 EGIT_UPDATE_CMD="git pull -f -u"
65 else
66 EGIT_UPDATE_CMD="git fetch -f -u"
67 fi
68
69 # @ECLASS-VARIABLE: EGIT_DIFFSTAT_CMD
70 # @DESCRIPTION:
71 # Git command for diffstat.
72 EGIT_DIFFSTAT_CMD="git --no-pager diff --stat"
73
74 # @ECLASS-VARIABLE: EGIT_OPTIONS
75 # @DESCRIPTION:
76 # This variable value is passed to clone and fetch.
77 : ${EGIT_OPTIONS:=}
78
79 # @ECLASS-VARIABLE: EGIT_MASTER
80 # @DESCRIPTION:
81 # Variable for specifying master branch.
82 # Usefull when upstream don't have master branch.
83 : ${EGIT_MASTER:=master}
84
85 # @ECLASS-VARIABLE: EGIT_REPO_URI
86 # @DESCRIPTION:
87 # URI for the repository
88 # e.g. http://foo, git://bar
89 # Supported protocols:
90 # http://
91 # https://
92 # git://
93 # git+ssh://
94 # rsync://
95 # ssh://
96 eval X="\$${PN//[-+]/_}_LIVE_REPO"
97 if [[ ${X} = "" ]]; then
98 : ${EGIT_REPO_URI:=}
99 else
100 EGIT_REPO_URI="${X}"
101 fi
102 # @ECLASS-VARIABLE: EGIT_PROJECT
103 # @DESCRIPTION:
104 # Project name, it must be unique across EGIT_STORE_DIR.
105 # Git eclass will check out the git repository into ${EGIT_STORE_DIR}/${EGIT_PROJECT}/${EGIT_REPO_URI##*/}
106 # Default is ${PN}.
107 : ${EGIT_PROJECT:=${PN}}
108
109 # @ECLASS-VARIABLE: EGIT_BOOTSTRAP
110 # @DESCRIPTION:
111 # bootstrap script or command like autogen.sh or etc...
112 : ${EGIT_BOOTSTRAP:=}
113
114 # @ECLASS-VARIABLE: EGIT_OFFLINE
115 # @DESCRIPTION:
116 # Set this variable to a non-empty value to disable the automatic updating of
117 # an GIT source tree. This is intended to be set outside the git source
118 # tree by users.
119 : ${EGIT_OFFLINE:=${ESCM_OFFLINE}}
120
121 # @ECLASS-VARIABLE: EGIT_PATCHES
122 # @DESCRIPTION:
123 # Similar to PATCHES array from base.eclass
124 # Only difference is that this patches are applied before bootstrap.
125 # Please take note that this variable should be bash array.
126
127 # @ECLASS-VARIABLE: EGIT_BRANCH
128 # @DESCRIPTION:
129 # git eclass can fetch any branch in git_fetch().
130 eval X="\$${PN//[-+]/_}_LIVE_BRANCH"
131 if [[ "${X}" = "" ]]; then
132 : ${EGIT_BRANCH:=master}
133 else
134 EGIT_BRANCH="${X}"
135 fi
136
137 # @ECLASS-VARIABLE: EGIT_COMMIT
138 # @DESCRIPTION:
139 # git eclass can checkout any commit.
140 eval X="\$${PN//[-+]/_}_LIVE_COMMIT"
141 if [[ "${X}" = "" ]]; then
142 : ${EGIT_COMMIT:=${EGIT_BRANCH}}
143 else
144 EGIT_COMMIT="${X}"
145 fi
146
147 # @ECLASS-VARIABLE: EGIT_REPACK
148 # @DESCRIPTION:
149 # Set to non-empty value to repack objects to save disk space. However this can
150 # take a long time with VERY big repositories.
151 : ${EGIT_REPACK:=}
152
153 # @ECLASS-VARIABLE: EGIT_PRUNE
154 # @DESCRIPTION:
155 # Set to non-empty value to prune loose objects on each fetch. This is useful
156 # if upstream rewinds and rebases branches often.
157 : ${EGIT_PRUNE:=}
158
159 # @FUNCTION: git_submodules
160 # @DESCRIPTION:
161 # Internal function wrapping the submodule initialisation and update
162 git_submodules() {
163 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
164 debug-print "git submodule init"
165 git submodule init
166 debug-print "git submodule sync"
167 git submodule sync
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 [[ -z ${EGIT_HAS_SUBMODULES} ]] && export GIT_DIR
197
198 # choose if user wants elog or just einfo.
199 if [[ -n ${EGIT_QUIET} ]]; 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 [[ -n ${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 [[ -n ${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 [[ -z ${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 [[ -n ${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 [[ -n ${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 [[ -n ${EGIT_REPACK} ]] || [[ -n ${EGIT_PRUNE} ]]; then
347 ebegin "Garbage collecting the repository"
348 local args
349 [[ -n ${EGIT_PRUNE} ]] && args='--prune'
350 git gc ${args}
351 eend $?
352 fi
353 popd &> /dev/null
354
355 # export the git version
356 export EGIT_VERSION="${cursha1}"
357
358 # log the repo state
359 [[ "${EGIT_COMMIT}" != "${EGIT_BRANCH}" ]] && ${elogcmd} " commit: ${EGIT_COMMIT}"
360 ${elogcmd} " branch: ${EGIT_BRANCH}"
361 ${elogcmd} " storage directory: \"${GIT_DIR}\""
362
363 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
364 pushd "${GIT_DIR}" &> /dev/null
365 debug-print "rsync -rlpgo . \"${EGIT_UNPACK_DIR:-${S}}\""
366 time rsync -rlpgo . "${EGIT_UNPACK_DIR:-${S}}"
367 popd &> /dev/null
368 else
369 unset GIT_DIR
370 debug-print "git clone -l -s -n \"${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}\" \"${EGIT_UNPACK_DIR:-${S}}\""
371 git clone -l -s -n "${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}" "${EGIT_UNPACK_DIR:-${S}}"
372 fi
373
374 pushd "${EGIT_UNPACK_DIR:-${S}}" &> /dev/null
375 git_branch
376 # submodules always reqire net (thanks to branches changing)
377 [[ -z ${EGIT_OFFLINE} ]] && git_submodules
378 popd &> /dev/null
379
380 echo ">>> Unpacked to ${EGIT_UNPACK_DIR:-${S}}"
381 }
382
383 # @FUNCTION: git_bootstrap
384 # @DESCRIPTION:
385 # Runs bootstrap command if EGIT_BOOTSTRAP variable contains some value
386 # Remember that what ever gets to the EGIT_BOOTSTRAP variable gets evaled by bash.
387 git_bootstrap() {
388 debug-print-function ${FUNCNAME} "$@"
389
390 if [[ -n ${EGIT_BOOTSTRAP} ]] ; then
391 pushd "${S}" > /dev/null
392 einfo "Starting bootstrap"
393
394 if [[ -f ${EGIT_BOOTSTRAP} ]]; then
395 # we have file in the repo which we should execute
396 debug-print "$FUNCNAME: bootstraping with file \"${EGIT_BOOTSTRAP}\""
397
398 if [[ -x ${EGIT_BOOTSTRAP} ]]; then
399 eval "./${EGIT_BOOTSTRAP}" \
400 || die "${EGIT}: bootstrap script failed"
401 else
402 eerror "\"${EGIT_BOOTSTRAP}\" is not executable."
403 eerror "Report upstream, or bug ebuild maintainer to remove bootstrap command."
404 die "${EGIT}: \"${EGIT_BOOTSTRAP}\" is not executable."
405 fi
406 else
407 # we execute some system command
408 debug-print "$FUNCNAME: bootstraping with commands \"${EGIT_BOOTSTRAP}\""
409
410 eval "${EGIT_BOOTSTRAP}" \
411 || die "${EGIT}: bootstrap commands failed."
412
413 fi
414
415 einfo "Bootstrap finished"
416 popd > /dev/null
417 fi
418 }
419
420 # @FUNCTION: git_apply_patches
421 # @DESCRIPTION:
422 # Apply patches from EGIT_PATCHES bash array.
423 # Preferred is using the variable as bash array but for now it allows to write
424 # it also as normal space separated string list. (This part of code should be
425 # removed when all ebuilds get converted on bash array).
426 git_apply_patches() {
427 debug-print-function ${FUNCNAME} "$@"
428
429 pushd "${EGIT_UNPACK_DIR:-${S}}" > /dev/null
430 if [[ ${#EGIT_PATCHES[@]} -gt 1 ]] ; then
431 for i in "${EGIT_PATCHES[@]}"; do
432 debug-print "$FUNCNAME: git_autopatch: patching from ${i}"
433 epatch "${i}"
434 done
435 elif [[ -n ${EGIT_PATCHES} ]]; then
436 # no need for loop if space separated string is passed.
437 debug-print "$FUNCNAME: git_autopatch: patching from ${EGIT_PATCHES}"
438 epatch "${EGIT_PATCHES}"
439 fi
440
441 popd > /dev/null
442 }
443
444 # @FUNCTION: git_src_unpack
445 # @DESCRIPTION:
446 # src_upack function, calls src_prepare one if EAPI!=2.
447 git_src_unpack() {
448 debug-print-function ${FUNCNAME} "$@"
449
450 git_fetch || die "${EGIT}: unknown problem in git_fetch()."
451
452 has src_prepare ${EXPORTED_FUNCTIONS} || git_src_prepare
453 }
454
455 # @FUNCTION: git_src_prepare
456 # @DESCRIPTION:
457 # src_prepare function for git stuff. Patches, bootstrap...
458 git_src_prepare() {
459 debug-print-function ${FUNCNAME} "$@"
460
461 git_apply_patches
462 git_bootstrap
463 }

  ViewVC Help
Powered by ViewVC 1.1.20