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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.54 - (show annotations) (download)
Wed Apr 20 10:57:42 2011 UTC (3 years, 8 months ago) by scarabeus
Branch: MAIN
Changes since 1.53: +5 -1 lines
Mark git.eclass as deprecated in favor of git-2 one.

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

  ViewVC Help
Powered by ViewVC 1.1.20