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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.41 - (show annotations) (download)
Sun Jan 31 10:13:57 2010 UTC (4 years, 5 months ago) by scarabeus
Branch: MAIN
Changes since 1.40: +2 -2 lines
Do the handling of not known eapi by depend and not by die.

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

  ViewVC Help
Powered by ViewVC 1.1.20