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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.61 - (show annotations) (download)
Fri Jul 5 17:39:10 2013 UTC (14 months, 2 weeks ago) by ulm
Branch: MAIN
Changes since 1.60: +2 -2 lines
@DEPRECATED is not a valid header tag.

1 # Copyright 1999-2013 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.60 2013/01/15 11:23:43 jlec 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 #
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 2|3|4|5) 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 eqawarn "git.eclass is deprecated."
200 eqawarn "Please update your ebuilds to use git-2 instead. For details, see"
201 eqawarn "http://archives.gentoo.org/gentoo-dev/msg_b7ba363cae580845819ae3501fb157e9.xml"
202
203 local GIT_DIR EGIT_CLONE_DIR oldsha1 cursha1 extra_clone_opts upstream_branch
204 [[ -z ${EGIT_HAS_SUBMODULES} ]] && export GIT_DIR
205
206 # choose if user wants elog or just einfo.
207 if [[ -n ${EGIT_QUIET} ]]; then
208 elogcmd="einfo"
209 else
210 elogcmd="elog"
211 fi
212
213 # If we have same branch and the tree we can do --depth 1 clone
214 # which outputs into really smaller data transfers.
215 # Sadly we can do shallow copy for now because quite a few packages need .git
216 # folder.
217 #[[ ${EGIT_COMMIT} = ${EGIT_BRANCH} ]] && \
218 # EGIT_FETCH_CMD="${EGIT_FETCH_CMD} --depth 1"
219 if [[ -n ${EGIT_TREE} ]] ; then
220 EGIT_COMMIT=${EGIT_TREE}
221 ewarn "QA: Usage of deprecated EGIT_TREE variable detected."
222 ewarn "QA: Use EGIT_COMMIT variable instead."
223 fi
224
225 # EGIT_REPO_URI is empty.
226 [[ -z ${EGIT_REPO_URI} ]] && die "${EGIT}: EGIT_REPO_URI is empty."
227
228 # check for the protocol or pull from a local repo.
229 if [[ -z ${EGIT_REPO_URI%%:*} ]] ; then
230 case ${EGIT_REPO_URI%%:*} in
231 git*|http|https|rsync|ssh) ;;
232 *) die "${EGIT}: protocol for fetch from "${EGIT_REPO_URI%:*}" is not yet implemented in eclass." ;;
233 esac
234 fi
235
236 # initial clone, we have to create master git storage directory and play
237 # nicely with sandbox
238 if [[ ! -d ${EGIT_STORE_DIR} ]] ; then
239 debug-print "${FUNCNAME}: initial clone. creating git directory"
240 addwrite /
241 mkdir -m 775 -p "${EGIT_STORE_DIR}" \
242 || die "${EGIT}: can't mkdir ${EGIT_STORE_DIR}."
243 export SANDBOX_WRITE="${SANDBOX_WRITE%%:/}"
244 fi
245
246 cd -P "${EGIT_STORE_DIR}" || die "${EGIT}: can't chdir to ${EGIT_STORE_DIR}"
247 EGIT_STORE_DIR=${PWD}
248
249 # allow writing into EGIT_STORE_DIR
250 addwrite "${EGIT_STORE_DIR}"
251
252 [[ -z ${EGIT_REPO_URI##*/} ]] && EGIT_REPO_URI="${EGIT_REPO_URI%/}"
253 EGIT_CLONE_DIR="${EGIT_PROJECT}"
254
255 debug-print "${FUNCNAME}: EGIT_OPTIONS = \"${EGIT_OPTIONS}\""
256
257 GIT_DIR="${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}"
258 # we also have to remove all shallow copied repositories
259 # and fetch them again
260 if [[ -e "${GIT_DIR}/shallow" ]]; then
261 rm -rf "${GIT_DIR}"
262 einfo "The ${EGIT_CLONE_DIR} was shallow copy. Refetching."
263 fi
264 # repack from bare copy to normal one
265 if [[ -n ${EGIT_HAS_SUBMODULES} ]] && [[ -d ${GIT_DIR} && ! -d ${GIT_DIR}/.git ]]; then
266 rm -rf "${GIT_DIR}"
267 einfo "The ${EGIT_CLONE_DIR} was bare copy. Refetching."
268 fi
269 if [[ -z ${EGIT_HAS_SUBMODULES} ]] && [[ -d ${GIT_DIR} && -d ${GIT_DIR}/.git ]]; then
270 rm -rf "${GIT_DIR}"
271 einfo "The ${EGIT_CLONE_DIR} was not a bare copy. Refetching."
272 fi
273
274 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
275 upstream_branch=origin/${EGIT_BRANCH}
276 else
277 upstream_branch=${EGIT_BRANCH}
278 extra_clone_opts=--bare
279 fi
280
281 if [[ ! -d ${GIT_DIR} ]] ; then
282 # first clone
283 ${elogcmd} "GIT NEW clone -->"
284 ${elogcmd} " repository: ${EGIT_REPO_URI}"
285
286 debug-print "${EGIT_FETCH_CMD} ${extra_clone_opts} ${EGIT_OPTIONS} \"${EGIT_REPO_URI}\" ${GIT_DIR}"
287 ${EGIT_FETCH_CMD} ${extra_clone_opts} ${EGIT_OPTIONS} "${EGIT_REPO_URI}" ${GIT_DIR} \
288 || die "${EGIT}: can't fetch from ${EGIT_REPO_URI}."
289
290 pushd "${GIT_DIR}" &> /dev/null
291 cursha1=$(git rev-parse ${upstream_branch})
292 ${elogcmd} " at the commit: ${cursha1}"
293
294 git_submodules
295 popd &> /dev/null
296 elif [[ -n ${EGIT_OFFLINE} ]] ; then
297 pushd "${GIT_DIR}" &> /dev/null
298 cursha1=$(git rev-parse ${upstream_branch})
299 ${elogcmd} "GIT offline update -->"
300 ${elogcmd} " repository: ${EGIT_REPO_URI}"
301 ${elogcmd} " at the commit: ${cursha1}"
302 popd &> /dev/null
303 else
304 pushd "${GIT_DIR}" &> /dev/null
305 # Git urls might change, so unconditionally set it here
306 git config remote.origin.url "${EGIT_REPO_URI}"
307
308 # fetch updates
309 ${elogcmd} "GIT update -->"
310 ${elogcmd} " repository: ${EGIT_REPO_URI}"
311
312 oldsha1=$(git rev-parse ${upstream_branch})
313
314 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
315 debug-print "${EGIT_UPDATE_CMD} ${EGIT_OPTIONS}"
316 # fix branching
317 git checkout ${EGIT_MASTER}
318 for x in $(git branch |grep -v "* ${EGIT_MASTER}" |tr '\n' ' '); do
319 git branch -D ${x}
320 done
321 ${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} \
322 || die "${EGIT}: can't update from ${EGIT_REPO_URI}."
323 else
324 debug-print "${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} origin ${EGIT_BRANCH}:${EGIT_BRANCH}"
325 ${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} origin ${EGIT_BRANCH}:${EGIT_BRANCH} \
326 || die "${EGIT}: can't update from ${EGIT_REPO_URI}."
327 fi
328
329 git_submodules
330 cursha1=$(git rev-parse ${upstream_branch})
331
332 # write out message based on the revisions
333 if [[ "${oldsha1}" != "${cursha1}" ]]; then
334 ${elogcmd} " updating from commit: ${oldsha1}"
335 ${elogcmd} " to commit: ${cursha1}"
336 else
337 ${elogcmd} " at the commit: ${cursha1}"
338 # @ECLASS-VARIABLE: LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED
339 # @DESCRIPTION:
340 # If this variable is set to TRUE in make.conf or somewhere in
341 # enviroment the package will fail if there is no update, thus in
342 # combination with --keep-going it would lead in not-updating
343 # pakcages that are up-to-date.
344 # TODO: this can lead to issues if more projects/packages use same repo
345 [[ ${LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED} = true ]] && \
346 debug-print "${FUNCNAME}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping." && \
347 die "${EGIT}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping."
348 fi
349 ${EGIT_DIFFSTAT_CMD} ${oldsha1}..${upstream_branch}
350 popd &> /dev/null
351 fi
352
353 pushd "${GIT_DIR}" &> /dev/null
354 if [[ -n ${EGIT_REPACK} ]] || [[ -n ${EGIT_PRUNE} ]]; then
355 ebegin "Garbage collecting the repository"
356 local args
357 [[ -n ${EGIT_PRUNE} ]] && args='--prune'
358 git gc ${args}
359 eend $?
360 fi
361 popd &> /dev/null
362
363 # export the git version
364 export EGIT_VERSION="${cursha1}"
365
366 # log the repo state
367 [[ "${EGIT_COMMIT}" != "${EGIT_BRANCH}" ]] && ${elogcmd} " commit: ${EGIT_COMMIT}"
368 ${elogcmd} " branch: ${EGIT_BRANCH}"
369 ${elogcmd} " storage directory: \"${GIT_DIR}\""
370
371 if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
372 pushd "${GIT_DIR}" &> /dev/null
373 debug-print "rsync -rlpgo . \"${EGIT_UNPACK_DIR:-${S}}\""
374 time rsync -rlpgo . "${EGIT_UNPACK_DIR:-${S}}"
375 popd &> /dev/null
376 else
377 unset GIT_DIR
378 debug-print "git clone -l -s -n \"${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}\" \"${EGIT_UNPACK_DIR:-${S}}\""
379 git clone -l -s -n "${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}" "${EGIT_UNPACK_DIR:-${S}}"
380 fi
381
382 pushd "${EGIT_UNPACK_DIR:-${S}}" &> /dev/null
383 git_branch
384 # submodules always reqire net (thanks to branches changing)
385 [[ -z ${EGIT_OFFLINE} ]] && git_submodules
386 popd &> /dev/null
387
388 echo ">>> Unpacked to ${EGIT_UNPACK_DIR:-${S}}"
389 }
390
391 # @FUNCTION: git_bootstrap
392 # @DESCRIPTION:
393 # Runs bootstrap command if EGIT_BOOTSTRAP variable contains some value
394 # Remember that what ever gets to the EGIT_BOOTSTRAP variable gets evaled by bash.
395 git_bootstrap() {
396 debug-print-function ${FUNCNAME} "$@"
397
398 if [[ -n ${EGIT_BOOTSTRAP} ]] ; then
399 pushd "${S}" > /dev/null
400 einfo "Starting bootstrap"
401
402 if [[ -f ${EGIT_BOOTSTRAP} ]]; then
403 # we have file in the repo which we should execute
404 debug-print "$FUNCNAME: bootstraping with file \"${EGIT_BOOTSTRAP}\""
405
406 if [[ -x ${EGIT_BOOTSTRAP} ]]; then
407 eval "./${EGIT_BOOTSTRAP}" \
408 || die "${EGIT}: bootstrap script failed"
409 else
410 eerror "\"${EGIT_BOOTSTRAP}\" is not executable."
411 eerror "Report upstream, or bug ebuild maintainer to remove bootstrap command."
412 die "${EGIT}: \"${EGIT_BOOTSTRAP}\" is not executable."
413 fi
414 else
415 # we execute some system command
416 debug-print "$FUNCNAME: bootstraping with commands \"${EGIT_BOOTSTRAP}\""
417
418 eval "${EGIT_BOOTSTRAP}" \
419 || die "${EGIT}: bootstrap commands failed."
420
421 fi
422
423 einfo "Bootstrap finished"
424 popd > /dev/null
425 fi
426 }
427
428 # @FUNCTION: git_apply_patches
429 # @DESCRIPTION:
430 # Apply patches from EGIT_PATCHES bash array.
431 # Preferred is using the variable as bash array but for now it allows to write
432 # it also as normal space separated string list. (This part of code should be
433 # removed when all ebuilds get converted on bash array).
434 git_apply_patches() {
435 debug-print-function ${FUNCNAME} "$@"
436
437 pushd "${EGIT_UNPACK_DIR:-${S}}" > /dev/null
438 if [[ ${#EGIT_PATCHES[@]} -gt 1 ]] ; then
439 for i in "${EGIT_PATCHES[@]}"; do
440 debug-print "$FUNCNAME: git_autopatch: patching from ${i}"
441 epatch "${i}"
442 done
443 elif [[ -n ${EGIT_PATCHES} ]]; then
444 # no need for loop if space separated string is passed.
445 debug-print "$FUNCNAME: git_autopatch: patching from ${EGIT_PATCHES}"
446 epatch "${EGIT_PATCHES}"
447 fi
448
449 popd > /dev/null
450 }
451
452 # @FUNCTION: git_src_unpack
453 # @DESCRIPTION:
454 # src_upack function, calls src_prepare one if EAPI!=2.
455 git_src_unpack() {
456 debug-print-function ${FUNCNAME} "$@"
457
458 git_fetch || die "${EGIT}: unknown problem in git_fetch()."
459
460 has src_prepare ${EXPORTED_FUNCTIONS} || git_src_prepare
461 }
462
463 # @FUNCTION: git_src_prepare
464 # @DESCRIPTION:
465 # src_prepare function for git stuff. Patches, bootstrap...
466 git_src_prepare() {
467 debug-print-function ${FUNCNAME} "$@"
468
469 git_apply_patches
470 git_bootstrap
471 }

  ViewVC Help
Powered by ViewVC 1.1.20