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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.57 - (show annotations) (download)
Mon Sep 12 12:49:44 2011 UTC (2 years, 7 months ago) by mgorny
Branch: MAIN
Changes since 1.56: +5 -1 lines
Issue deprecation warning for devs on use.

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

  ViewVC Help
Powered by ViewVC 1.1.20