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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.48 - (show annotations) (download)
Tue Jul 27 12:39:34 2010 UTC (4 years, 2 months ago) by reavertm
Branch: MAIN
Changes since 1.47: +5 -9 lines
Do not strip -git suffix from ${PN} when setting default EGIT_PROJECT. PN with -git suffix is perfectly acceptable package name.

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

  ViewVC Help
Powered by ViewVC 1.1.20