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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.36 - (show annotations) (download)
Wed Jan 13 22:14:59 2010 UTC (4 years, 10 months ago) by scarabeus
Branch: MAIN
Changes since 1.35: +21 -17 lines
Fix that EGIT_TREE and EGIT_BRANCH again, now it looks all fine, fully tested with x11 repos and mainly mesa.

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

  ViewVC Help
Powered by ViewVC 1.1.20