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

Diff of /eclass/git-r3.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.9 Revision 1.35
1# Copyright 1999-2013 Gentoo Foundation 1# Copyright 1999-2014 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/git-r3.eclass,v 1.9 2013/09/25 11:19:09 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/git-r3.eclass,v 1.35 2014/03/02 11:49:05 mgorny Exp $
4 4
5# @ECLASS: git-r3.eclass 5# @ECLASS: git-r3.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# Michał Górny <mgorny@gentoo.org> 7# Michał Górny <mgorny@gentoo.org>
8# @BLURB: Eclass for fetching and unpacking git repositories. 8# @BLURB: Eclass for fetching and unpacking git repositories.
9# @DESCRIPTION: 9# @DESCRIPTION:
10# Third generation eclass for easing maitenance of live ebuilds using 10# Third generation eclass for easing maitenance of live ebuilds using
11# git as remote repository. The eclass supports lightweight (shallow) 11# git as remote repository.
12# clones and bare clones of submodules.
13 12
14case "${EAPI:-0}" in 13case "${EAPI:-0}" in
15 0|1|2|3|4|5) 14 0|1|2|3|4|5)
16 ;; 15 ;;
17 *) 16 *)
27 26
28EXPORT_FUNCTIONS src_unpack 27EXPORT_FUNCTIONS src_unpack
29 28
30if [[ ! ${_GIT_R3} ]]; then 29if [[ ! ${_GIT_R3} ]]; then
31 30
31if [[ ! ${_INHERITED_BY_GIT_2} ]]; then
32 DEPEND=">=dev-vcs/git-1.8.2.1"
33fi
34
35# @ECLASS-VARIABLE: EGIT_CLONE_TYPE
36# @DESCRIPTION:
37# Type of clone that should be used against the remote repository.
38# This can be either of: 'mirror', 'single', 'shallow'.
39#
40# The 'mirror' type clones all remote branches and tags with complete
41# history and all notes. EGIT_COMMIT can specify any commit hash.
42# Upstream-removed branches and tags are purged from the local clone
43# while fetching. This mode is suitable for cloning the local copy
44# for development or hosting a local git mirror. However, clones
45# of repositories with large diverged branches may quickly grow large.
46#
47# The 'single' type clones only the requested branch or tag. Tags
48# referencing commits throughout the branch history are fetched as well,
49# and all notes. EGIT_COMMIT can safely specify only hashes
50# in the current branch. No purging of old references is done (if you
51# often switch branches, you may need to remove stale branches
52# yourself). This mode is suitable for general use.
53#
54# The 'shallow' type clones only the newest commit on requested branch
55# or tag. EGIT_COMMIT can only specify tags, and since the history is
56# unavailable calls like 'git describe' will not reference prior tags.
57# No purging of old references is done. This mode is intended mostly for
58# embedded systems with limited disk space.
59: ${EGIT_CLONE_TYPE:=single}
60
61# @ECLASS-VARIABLE: EGIT_MIN_CLONE_TYPE
62# @DESCRIPTION:
63# 'Minimum' clone type supported by the ebuild. Takes same values
64# as EGIT_CLONE_TYPE. When user sets a type that's 'lower' (that is,
65# later on the list) than EGIT_MIN_CLONE_TYPE, the eclass uses
66# EGIT_MIN_CLONE_TYPE instead.
67#
68# A common case is to use 'single' whenever the build system requires
69# access to full branch history or the remote (Google Code) does not
70# support shallow clones. Please use sparingly, and to fix fatal errors
71# rather than 'non-pretty versions'.
72: ${EGIT_MIN_CLONE_TYPE:=shallow}
73
32# @ECLASS-VARIABLE: EGIT3_STORE_DIR 74# @ECLASS-VARIABLE: EGIT3_STORE_DIR
33# @DESCRIPTION: 75# @DESCRIPTION:
34# Storage directory for git sources. 76# Storage directory for git sources.
35# 77#
78# This is intended to be set by user in make.conf. Ebuilds must not set
79# it.
80#
36# EGIT3_STORE_DIR=${DISTDIR}/git3-src 81# EGIT3_STORE_DIR=${DISTDIR}/git3-src
82
83# @ECLASS-VARIABLE: EGIT_MIRROR_URI
84# @DEFAULT_UNSET
85# @DESCRIPTION:
86# 'Top' URI to a local git mirror. If specified, the eclass will try
87# to fetch from the local mirror instead of using the remote repository.
88#
89# The mirror needs to follow EGIT3_STORE_DIR structure. The directory
90# created by eclass can be used for that purpose.
91#
92# Example:
93# @CODE
94# EGIT_MIRROR_URI="git://mirror.lan/"
95# @CODE
37 96
38# @ECLASS-VARIABLE: EGIT_REPO_URI 97# @ECLASS-VARIABLE: EGIT_REPO_URI
39# @REQUIRED 98# @REQUIRED
40# @DESCRIPTION: 99# @DESCRIPTION:
41# URIs to the repository, e.g. git://foo, https://foo. If multiple URIs 100# URIs to the repository, e.g. git://foo, https://foo. If multiple URIs
77# @DESCRIPTION: 136# @DESCRIPTION:
78# The directory to check the git sources out to. 137# The directory to check the git sources out to.
79# 138#
80# EGIT_CHECKOUT_DIR=${WORKDIR}/${P} 139# EGIT_CHECKOUT_DIR=${WORKDIR}/${P}
81 140
82# @ECLASS-VARIABLE: EGIT_NONSHALLOW
83# @DEFAULT_UNSET
84# @DESCRIPTION:
85# Disable performing shallow fetches/clones. Shallow clones have
86# a fair number of limitations. Therefore, if you'd like the eclass to
87# perform complete clones instead, set this to a non-null value.
88#
89# This variable is to be set in make.conf. Ebuilds are not allowed
90# to set it.
91
92# @FUNCTION: _git-r3_env_setup 141# @FUNCTION: _git-r3_env_setup
93# @INTERNAL 142# @INTERNAL
94# @DESCRIPTION: 143# @DESCRIPTION:
95# Set the eclass variables as necessary for operation. This can involve 144# Set the eclass variables as necessary for operation. This can involve
96# setting EGIT_* to defaults or ${PN}_LIVE_* variables. 145# setting EGIT_* to defaults or ${PN}_LIVE_* variables.
97_git-r3_env_setup() { 146_git-r3_env_setup() {
98 debug-print-function ${FUNCNAME} "$@" 147 debug-print-function ${FUNCNAME} "$@"
148
149 # check the clone type
150 case "${EGIT_CLONE_TYPE}" in
151 mirror|single|shallow)
152 ;;
153 *)
154 die "Invalid EGIT_CLONE_TYPE=${EGIT_CLONE_TYPE}"
155 esac
156 case "${EGIT_MIN_CLONE_TYPE}" in
157 shallow)
158 ;;
159 single)
160 if [[ ${EGIT_CLONE_TYPE} == shallow ]]; then
161 einfo "git-r3: ebuild needs to be cloned in 'single' mode, adjusting"
162 EGIT_CLONE_TYPE=single
163 fi
164 ;;
165 mirror)
166 if [[ ${EGIT_CLONE_TYPE} != mirror ]]; then
167 einfo "git-r3: ebuild needs to be cloned in 'mirror' mode, adjusting"
168 EGIT_CLONE_TYPE=mirror
169 fi
170 ;;
171 *)
172 die "Invalid EGIT_MIN_CLONE_TYPE=${EGIT_MIN_CLONE_TYPE}"
173 esac
99 174
100 local esc_pn livevar 175 local esc_pn livevar
101 esc_pn=${PN//[-+]/_} 176 esc_pn=${PN//[-+]/_}
102 177
103 livevar=${esc_pn}_LIVE_REPO 178 livevar=${esc_pn}_LIVE_REPO
204 GIT_DIR=${EGIT3_STORE_DIR}/${repo_name} 279 GIT_DIR=${EGIT3_STORE_DIR}/${repo_name}
205 280
206 if [[ ! -d ${EGIT3_STORE_DIR} ]]; then 281 if [[ ! -d ${EGIT3_STORE_DIR} ]]; then
207 ( 282 (
208 addwrite / 283 addwrite /
209 mkdir -m0755 -p "${EGIT3_STORE_DIR}" 284 mkdir -m0755 -p "${EGIT3_STORE_DIR}" || die
210 ) || die "Unable to create ${EGIT3_STORE_DIR}" 285 ) || die "Unable to create ${EGIT3_STORE_DIR}"
211 fi 286 fi
212 287
213 addwrite "${EGIT3_STORE_DIR}" 288 addwrite "${EGIT3_STORE_DIR}"
214 if [[ ! -d ${GIT_DIR} ]]; then 289 if [[ ! -d ${GIT_DIR} ]]; then
215 mkdir "${GIT_DIR}" || die 290 mkdir "${GIT_DIR}" || die
216 git init --bare || die 291 git init --bare || die
217
218 if [[ ! ${EGIT_NONSHALLOW} ]]; then
219 # avoid auto-unshallow :)
220 touch "${GIT_DIR}"/shallow || die
221 fi
222 fi 292 fi
223} 293}
224 294
225# @FUNCTION: _git-r3_set_submodules 295# @FUNCTION: _git-r3_set_submodules
226# @USAGE: <file-contents> 296# @USAGE: <file-contents>
244 [[ ${l} == submodule.*.url=* ]] || continue 314 [[ ${l} == submodule.*.url=* ]] || continue
245 315
246 l=${l#submodule.} 316 l=${l#submodule.}
247 local subname=${l%%.url=*} 317 local subname=${l%%.url=*}
248 318
319 # skip modules that have 'update = none', bug #487262.
320 local upd=$(echo "${data}" | git config -f /dev/fd/0 \
321 submodule."${subname}".update)
322 [[ ${upd} == none ]] && continue
323
249 submodules+=( 324 submodules+=(
250 "${subname}" 325 "${subname}"
251 "$(echo "${data}" | git config -f /dev/fd/0 \ 326 "$(echo "${data}" | git config -f /dev/fd/0 \
252 submodule."${subname}".url)" 327 submodule."${subname}".url || die)"
253 "$(echo "${data}" | git config -f /dev/fd/0 \ 328 "$(echo "${data}" | git config -f /dev/fd/0 \
254 submodule."${subname}".path)" 329 submodule."${subname}".path || die)"
255 ) 330 )
256 done < <(echo "${data}" | git config -f /dev/fd/0 -l) 331 done < <(echo "${data}" | git config -f /dev/fd/0 -l || die)
257} 332}
258 333
259# @FUNCTION: _git-r3_smart_fetch 334# @FUNCTION: _git-r3_is_local_repo
260# @USAGE: <git-fetch-args>... 335# @USAGE: <repo-uri>
336# @INTERNAL
261# @DESCRIPTION: 337# @DESCRIPTION:
262# Try fetching without '--depth' and switch to '--depth 1' if that 338# Determine whether the given URI specifies a local (on-disk)
263# will involve less objects fetched. 339# repository.
264_git-r3_smart_fetch() { 340_git-r3_is_local_repo() {
265 debug-print-function ${FUNCNAME} "$@" 341 debug-print-function ${FUNCNAME} "$@"
266 342
267 local sed_regexp='.*Counting objects: \([0-9]*\), done\..*' 343 local uri=${1}
268 344
269 # start the main fetch 345 [[ ${uri} == file://* || ${uri} == /* ]]
270 local cmd=( git fetch --progress "${@}" ) 346}
271 echo "${cmd[@]}" >&2
272 347
273 # we copy the output to the 'sed' pipe for parsing. whenever sed finds 348# @FUNCTION: _git-r3_find_head
274 # the process count, it quits quickly to avoid delays in writing it. 349# @USAGE: <head-ref>
275 # then, we start a dummy 'cat' to keep the pipe alive 350# @INTERNAL
351# @DESCRIPTION:
352# Given a ref to which remote HEAD was fetched, try to find
353# a branch matching the commit. Expects 'git show-ref'
354# or 'git ls-remote' output on stdin.
355_git-r3_find_head() {
356 debug-print-function ${FUNCNAME} "$@"
276 357
277 "${cmd[@]}" 2>&1 \ 358 local head_ref=${1}
278 | tee >( 359 local head_hash=$(git rev-parse --verify "${1}" || die)
279 sed -n -e "/${sed_regexp}/{s/${sed_regexp}/\1/p;q}" \ 360 local matching_ref
280 > "${T}"/git-r3_main.count
281 exec cat >/dev/null
282 ) &
283 local main_pid=${!}
284 361
285 # start the helper process 362 # TODO: some transports support peeking at symbolic remote refs
286 _git-r3_sub_fetch() { 363 # find a way to use that rather than guessing
287 # wait for main fetch to get object count; if the server doesn't 364
288 # output it, we won't even launch the parallel process 365 # (based on guess_remote_head() in git-1.9.0/remote.c)
289 while [[ ! -s ${T}/git-r3_main.count ]]; do 366 local h ref
290 sleep 0.25 367 while read h ref; do
368 # look for matching head
369 if [[ ${h} == ${head_hash} ]]; then
370 # either take the first matching ref, or master if it is there
371 if [[ ! ${matching_ref} || ${ref} == refs/heads/master ]]; then
372 matching_ref=${ref}
373 fi
374 fi
291 done 375 done
292 376
293 # ok, let's see if parallel fetch gives us smaller count 377 if [[ ! ${matching_ref} ]]; then
294 # --dry-run will prevent it from writing to the local clone 378 die "Unable to find a matching branch for remote HEAD (${head_hash})"
295 # and sed should terminate git with SIGPIPE
296 local sub_count=$(git fetch --progress --dry-run --depth 1 "${@}" 2>&1 \
297 | sed -n -e "/${sed_regexp}/{s/${sed_regexp}/\1/p;q}")
298 local main_count=$(<"${T}"/git-r3_main.count)
299
300 # let's be real sure that '--depth 1' will be good for us.
301 # note that we have purely objects counts, and '--depth 1'
302 # may involve much bigger objects
303 if [[ ${main_count} && ${main_count} -ge $(( sub_count * 3/2 )) ]]
304 then
305 # signal that we want shallow fetch instead,
306 # and terminate the non-shallow fetch process
307 touch "${T}"/git-r3_want_shallow || die
308 kill ${main_pid} &>/dev/null
309 exit 0
310 fi 379 fi
311 380
312 exit 1 381 echo "${matching_ref}"
313 }
314 _git-r3_sub_fetch "${@}" &
315 local sub_pid=${!}
316
317 # wait for main process to terminate, either of its own
318 # or by signal from subprocess
319 wait ${main_pid}
320 local main_ret=${?}
321
322 # wait for subprocess to terminate, killing it if necessary.
323 # if main fetch finished before it, there's no point in keeping
324 # it alive. if main fetch was killed by it, it's done anyway
325 kill ${sub_pid} &>/dev/null
326 wait ${sub_pid}
327
328 # now see if subprocess wanted to tell us something...
329 if [[ -f ${T}/git-r3_want_shallow ]]; then
330 rm "${T}"/git-r3_want_shallow || die
331
332 # if fetch finished already (wasn't killed), ignore it
333 [[ ${main_ret} -eq 0 ]] && return 0
334
335 # otherwise, restart as shallow fetch
336 einfo "Restarting fetch using --depth 1 to save bandwidth ..."
337 local cmd=( git fetch --progress --depth 1 "${@}" )
338 echo "${cmd[@]}" >&2
339 "${cmd[@]}"
340 main_ret=${?}
341 fi
342
343 return ${main_ret}
344} 382}
345 383
346# @FUNCTION: git-r3_fetch 384# @FUNCTION: git-r3_fetch
347# @USAGE: [<repo-uri> [<remote-ref> [<local-id>]]] 385# @USAGE: [<repo-uri> [<remote-ref> [<local-id>]]]
348# @DESCRIPTION: 386# @DESCRIPTION:
361# is set to a non-null value. 399# is set to a non-null value.
362# 400#
363# <local-id> specifies the local branch identifier that will be used to 401# <local-id> specifies the local branch identifier that will be used to
364# locally store the fetch result. It should be unique to multiple 402# locally store the fetch result. It should be unique to multiple
365# fetches within the repository that can be performed at the same time 403# fetches within the repository that can be performed at the same time
366# (including parallel merges). It defaults to ${CATEGORY}/${PN}/${SLOT}. 404# (including parallel merges). It defaults to ${CATEGORY}/${PN}/${SLOT%/*}.
367# This default should be fine unless you are fetching multiple trees 405# This default should be fine unless you are fetching multiple trees
368# from the same repository in the same ebuild. 406# from the same repository in the same ebuild.
369# 407#
370# The fetch operation will affect the EGIT_STORE only. It will not touch 408# The fetch operation will affect the EGIT_STORE only. It will not touch
371# the working copy, nor export any environment variables. 409# the working copy, nor export any environment variables.
372# If the repository contains submodules, they will be fetched 410# If the repository contains submodules, they will be fetched
373# recursively. 411# recursively.
374git-r3_fetch() { 412git-r3_fetch() {
375 debug-print-function ${FUNCNAME} "$@" 413 debug-print-function ${FUNCNAME} "$@"
376 414
415 [[ ${EVCS_OFFLINE} ]] && return
416
417 local repos
418 if [[ ${1} ]]; then
419 repos=( ${1} )
377 if [[ $(declare -p EGIT_REPO_URI) != "declare -a"* ]]; then 420 elif [[ $(declare -p EGIT_REPO_URI) == "declare -a"* ]]; then
378 local EGIT_REPO_URI=( ${EGIT_REPO_URI} )
379 fi
380
381 local repos=( "${1:-${EGIT_REPO_URI[@]}}" ) 421 repos=( "${EGIT_REPO_URI[@]}" )
422 else
423 repos=( ${EGIT_REPO_URI} )
424 fi
425
382 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}} 426 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
383 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}} 427 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
384 local local_id=${3:-${CATEGORY}/${PN}/${SLOT}} 428 local local_id=${3:-${CATEGORY}/${PN}/${SLOT%/*}}
385 local local_ref=refs/heads/${local_id}/__main__ 429 local local_ref=refs/git-r3/${local_id}/__main__
386 430
387 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset" 431 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
388 432
389 local -x GIT_DIR 433 local -x GIT_DIR
390 _git-r3_set_gitdir "${repos[0]}" 434 _git-r3_set_gitdir "${repos[0]}"
435
436 # prepend the local mirror if applicable
437 if [[ ${EGIT_MIRROR_URI} ]]; then
438 repos=(
439 "${EGIT_MIRROR_URI%/}/${GIT_DIR##*/}"
440 "${repos[@]}"
441 )
442 fi
391 443
392 # try to fetch from the remote 444 # try to fetch from the remote
393 local r success 445 local r success
394 for r in "${repos[@]}"; do 446 for r in "${repos[@]}"; do
447 einfo "Fetching ${r} ..."
448
449 local fetch_command=( git fetch "${r}" )
450
451 if [[ ${EGIT_CLONE_TYPE} == mirror ]]; then
452 fetch_command+=(
453 --prune
454 # mirror the remote branches as local branches
455 "refs/heads/*:refs/heads/*"
456 # pull tags explicitly in order to prune them properly
457 "refs/tags/*:refs/tags/*"
458 # notes in case something needs them
459 "refs/notes/*:refs/notes/*"
460 # and HEAD in case we need the default branch
461 # (we keep it in refs/git-r3 since otherwise --prune interferes)
462 HEAD:refs/git-r3/HEAD
463 )
464 else # single or shallow
465 local fetch_l fetch_r
466
467 if [[ ${remote_ref} == HEAD ]]; then
468 # HEAD
469 fetch_l=HEAD
470 elif [[ ${remote_ref} == refs/heads/* ]]; then
471 # regular branch
472 fetch_l=${remote_ref}
473 else
474 # tag or commit...
475 # let ls-remote figure it out
476 local tagref=$(git ls-remote "${r}" "refs/tags/${remote_ref}")
477
478 # if it was a tag, ls-remote obtained a hash
479 if [[ ${tagref} ]]; then
480 # tag
481 fetch_l=refs/tags/${remote_ref}
482 else
483 # commit
484 # so we need to fetch the branch
485 if [[ ${branch} ]]; then
486 fetch_l=${branch}
487 else
488 fetch_l=HEAD
489 fi
490
491 # fetching by commit in shallow mode? can't do.
492 if [[ ${EGIT_CLONE_TYPE} == shallow ]]; then
493 local EGIT_CLONE_TYPE=single
494 fi
495 fi
496 fi
497
498 if [[ ${fetch_l} == HEAD ]]; then
499 fetch_r=refs/git-r3/HEAD
500 else
501 fetch_r=${fetch_l}
502 fi
503
504 fetch_command+=(
505 "${fetch_l}:${fetch_r}"
506 )
507 fi
508
509 if [[ ${EGIT_CLONE_TYPE} == shallow ]]; then
510 # use '--depth 1' when fetching a new branch
511 if [[ ! $(git rev-parse --quiet --verify "${fetch_r}") ]]
512 then
513 fetch_command+=( --depth 1 )
514 fi
515 else # non-shallow mode
516 if [[ -f ${GIT_DIR}/shallow ]]; then
517 fetch_command+=( --unshallow )
518 fi
519 fi
520
521 set -- "${fetch_command[@]}"
522 echo "${@}" >&2
523 if "${@}"; then
524 if [[ ${EGIT_CLONE_TYPE} == mirror ]]; then
525 # find remote HEAD and update our HEAD properly
526 git symbolic-ref HEAD \
527 "$(_git-r3_find_head refs/git-r3/HEAD \
528 < <(git show-ref --heads || die))" \
529 || die "Unable to update HEAD"
530 else # single or shallow
531 if [[ ${fetch_l} == HEAD ]]; then
532 # find out what branch we fetched as HEAD
533 local head_branch=$(_git-r3_find_head \
534 refs/git-r3/HEAD \
535 < <(git ls-remote --heads "${r}" || die))
536
537 # and move it to its regular place
538 git update-ref --no-deref "${head_branch}" \
539 refs/git-r3/HEAD \
540 || die "Unable to sync HEAD branch ${head_branch}"
541 git symbolic-ref HEAD "${head_branch}" \
542 || die "Unable to update HEAD"
543 fi
544 fi
545
546 # now let's see what the user wants from us
547 local full_remote_ref=$(
548 git rev-parse --verify --symbolic-full-name "${remote_ref}"
549 )
550
551 if [[ ${full_remote_ref} ]]; then
552 # when we are given a ref, create a symbolic ref
553 # so that we preserve the actual argument
554 set -- git symbolic-ref "${local_ref}" "${full_remote_ref}"
555 else
556 # otherwise, we were likely given a commit id
557 set -- git update-ref --no-deref "${local_ref}" "${remote_ref}"
558 fi
559
560 echo "${@}" >&2
561 if ! "${@}"; then
562 die "Referencing ${remote_ref} failed (wrong ref?)."
563 fi
564
565 success=1
566 break
567 fi
568 done
569 [[ ${success} ]] || die "Unable to fetch from any of EGIT_REPO_URI"
570
571 # recursively fetch submodules
572 if git cat-file -e "${local_ref}":.gitmodules &>/dev/null; then
573 local submodules
574 _git-r3_set_submodules \
575 "$(git cat-file -p "${local_ref}":.gitmodules || die)"
576
577 while [[ ${submodules[@]} ]]; do
578 local subname=${submodules[0]}
579 local url=${submodules[1]}
580 local path=${submodules[2]}
581 local commit=$(git rev-parse "${local_ref}:${path}")
582
583 if [[ ! ${commit} ]]; then
584 die "Unable to get commit id for submodule ${subname}"
585 fi
586 if [[ ${url} == ./* || ${url} == ../* ]]; then
587 local subrepos=( "${repos[@]/%//${url}}" )
588 else
589 local subrepos=( "${url}" )
590 fi
591
592 git-r3_fetch "${subrepos[*]}" "${commit}" "${local_id}/${subname}"
593
594 submodules=( "${submodules[@]:3}" ) # shift
595 done
596 fi
597}
598
599# @FUNCTION: git-r3_checkout
600# @USAGE: [<repo-uri> [<checkout-path> [<local-id>]]]
601# @DESCRIPTION:
602# Check the previously fetched tree to the working copy.
603#
604# <repo-uri> specifies the repository URIs, as a space-separated list.
605# The first URI will be used as repository group identifier
606# and therefore must be used consistently with git-r3_fetch.
607# The remaining URIs are not used and therefore may be omitted.
608# When not specified, defaults to ${EGIT_REPO_URI}.
609#
610# <checkout-path> specifies the path to place the checkout. It defaults
611# to ${EGIT_CHECKOUT_DIR} if set, otherwise to ${WORKDIR}/${P}.
612#
613# <local-id> needs to specify the local identifier that was used
614# for respective git-r3_fetch.
615#
616# The checkout operation will write to the working copy, and export
617# the repository state into the environment. If the repository contains
618# submodules, they will be checked out recursively.
619git-r3_checkout() {
620 debug-print-function ${FUNCNAME} "$@"
621
622 local repos
623 if [[ ${1} ]]; then
624 repos=( ${1} )
625 elif [[ $(declare -p EGIT_REPO_URI) == "declare -a"* ]]; then
626 repos=( "${EGIT_REPO_URI[@]}" )
627 else
628 repos=( ${EGIT_REPO_URI} )
629 fi
630
631 local out_dir=${2:-${EGIT_CHECKOUT_DIR:-${WORKDIR}/${P}}}
632 local local_id=${3:-${CATEGORY}/${PN}/${SLOT%/*}}
633
634 local -x GIT_DIR
635 _git-r3_set_gitdir "${repos[0]}"
636
637 einfo "Checking out ${repos[0]} to ${out_dir} ..."
638
639 if ! git cat-file -e refs/git-r3/"${local_id}"/__main__; then
640 if [[ ${EVCS_OFFLINE} ]]; then
641 die "No local clone of ${repos[0]}. Unable to work with EVCS_OFFLINE."
642 else
643 die "Logic error: no local clone of ${repos[0]}. git-r3_fetch not used?"
644 fi
645 fi
646 local remote_ref=$(
647 git symbolic-ref --quiet refs/git-r3/"${local_id}"/__main__
648 )
649 local new_commit_id=$(
650 git rev-parse --verify refs/git-r3/"${local_id}"/__main__
651 )
652
653 git-r3_sub_checkout() {
654 local orig_repo=${GIT_DIR}
655 local -x GIT_DIR=${out_dir}/.git
656 local -x GIT_WORK_TREE=${out_dir}
657
658 mkdir -p "${out_dir}" || die
659
660 # use git init+fetch instead of clone since the latter doesn't like
661 # non-empty directories.
662
663 git init --quiet || die
664 # setup 'alternates' to avoid copying objects
665 echo "${orig_repo}/objects" > "${GIT_DIR}"/objects/info/alternates || die
666 # now copy the refs
667 # [htn]* safely catches heads, tags, notes without complaining
668 # on non-existing ones, and omits internal 'git-r3' ref
669 cp -R "${orig_repo}"/refs/[htn]* "${GIT_DIR}"/refs/ || die
670
671 # (no need to copy HEAD, we will set it via checkout)
672
673 if [[ -f ${orig_repo}/shallow ]]; then
674 cp "${orig_repo}"/shallow "${GIT_DIR}"/ || die
675 fi
676
677 set -- git checkout --quiet
678 if [[ ${remote_ref} ]]; then
679 set -- "${@}" "${remote_ref#refs/heads/}"
680 else
681 set -- "${@}" "${new_commit_id}"
682 fi
683 echo "${@}" >&2
684 "${@}" || die "git checkout ${remote_ref:-${new_commit_id}} failed"
685 }
686 git-r3_sub_checkout
687
688 local old_commit_id=$(
689 git rev-parse --quiet --verify refs/git-r3/"${local_id}"/__old__
690 )
691 if [[ ! ${old_commit_id} ]]; then
692 echo "GIT NEW branch -->"
693 echo " repository: ${repos[0]}"
694 echo " at the commit: ${new_commit_id}"
695 else
696 # diff against previous revision
697 echo "GIT update -->"
698 echo " repository: ${repos[0]}"
699 # write out message based on the revisions
700 if [[ "${old_commit_id}" != "${new_commit_id}" ]]; then
701 echo " updating from commit: ${old_commit_id}"
702 echo " to commit: ${new_commit_id}"
703
704 git --no-pager diff --stat \
705 ${old_commit_id}..${new_commit_id}
706 else
707 echo " at the commit: ${new_commit_id}"
708 fi
709 fi
710 git update-ref --no-deref refs/git-r3/"${local_id}"/{__old__,__main__} || die
711
712 # recursively checkout submodules
713 if [[ -f ${out_dir}/.gitmodules ]]; then
714 local submodules
715 _git-r3_set_submodules \
716 "$(<"${out_dir}"/.gitmodules)"
717
718 while [[ ${submodules[@]} ]]; do
719 local subname=${submodules[0]}
720 local url=${submodules[1]}
721 local path=${submodules[2]}
722
723 if [[ ${url} == ./* || ${url} == ../* ]]; then
724 url=${repos[0]%%/}/${url}
725 fi
726
727 git-r3_checkout "${url}" "${out_dir}/${path}" \
728 "${local_id}/${subname}"
729
730 submodules=( "${submodules[@]:3}" ) # shift
731 done
732 fi
733
734 # keep this *after* submodules
735 export EGIT_DIR=${GIT_DIR}
736 export EGIT_VERSION=${new_commit_id}
737}
738
739# @FUNCTION: git-r3_peek_remote_ref
740# @USAGE: [<repo-uri> [<remote-ref>]]
741# @DESCRIPTION:
742# Peek the reference in the remote repository and print the matching
743# (newest) commit SHA1.
744#
745# <repo-uri> specifies the repository URIs to fetch from, as a space-
746# -separated list. When not specified, defaults to ${EGIT_REPO_URI}.
747#
748# <remote-ref> specifies the remote ref to peek. It is preferred to use
749# 'refs/heads/<branch-name>' for branches and 'refs/tags/<tag-name>'
750# for tags. Alternatively, 'HEAD' may be used for upstream default
751# branch. Defaults to the first of EGIT_COMMIT, EGIT_BRANCH or literal
752# 'HEAD' that is set to a non-null value.
753#
754# The operation will be done purely on the remote, without using local
755# storage. If commit SHA1 is provided as <remote-ref>, the function will
756# fail due to limitations of git protocol.
757#
758# On success, the function returns 0 and writes hexadecimal commit SHA1
759# to stdout. On failure, the function returns 1.
760git-r3_peek_remote_ref() {
761 debug-print-function ${FUNCNAME} "$@"
762
763 local repos
764 if [[ ${1} ]]; then
765 repos=( ${1} )
766 elif [[ $(declare -p EGIT_REPO_URI) == "declare -a"* ]]; then
767 repos=( "${EGIT_REPO_URI[@]}" )
768 else
769 repos=( ${EGIT_REPO_URI} )
770 fi
771
772 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
773 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
774
775 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
776
777 local r success
778 for r in "${repos[@]}"; do
395 einfo "Fetching ${remote_ref} from ${r} ..." 779 einfo "Peeking ${remote_ref} on ${r} ..." >&2
396 780
397 local is_branch lookup_ref 781 local is_branch lookup_ref
398 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]] 782 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]]
399 then 783 then
400 is_branch=1 784 is_branch=1
403 # ls-remote by commit is going to fail anyway, 787 # ls-remote by commit is going to fail anyway,
404 # so we may as well pass refs/tags/ABCDEF... 788 # so we may as well pass refs/tags/ABCDEF...
405 lookup_ref=refs/tags/${remote_ref} 789 lookup_ref=refs/tags/${remote_ref}
406 fi 790 fi
407 791
408 # first, try ls-remote to see if ${remote_ref} is a real ref
409 # and not a commit id. if it succeeds, we can pass ${remote_ref}
410 # to 'fetch'. otherwise, we will just fetch everything
411
412 # split on whitespace
413 local ref=(
414 $(git ls-remote "${r}" "${lookup_ref}" || echo __FAIL__)
415 )
416
417 # normally, ref[0] is a hash, so we can do magic strings here
418 [[ ${ref[0]} == __FAIL__ ]] && continue
419
420 local nonshallow=${EGIT_NONSHALLOW}
421 local ref_param=()
422 if [[ ! ${ref[0]} ]]; then
423 nonshallow=1
424 fi
425
426 # 1. if we need a non-shallow clone and we have a shallow one,
427 # we need to unshallow it explicitly.
428 # 2. if we want a shallow clone, we just pass '--depth 1'
429 # to the first fetch in the repo. passing '--depth'
430 # to further requests usually results in more data being
431 # downloaded than without it.
432 # 3. if we update a shallow clone, we try without '--depth'
433 # first since that usually transfers less data. however,
434 # we use git-r3_smart_fetch that can switch into '--depth 1'
435 # if that looks beneficial.
436
437 local fetch_command=( git fetch )
438 if [[ ${nonshallow} ]]; then
439 if [[ -f ${GIT_DIR}/shallow ]]; then
440 ref_param+=( --unshallow )
441 fi
442 else
443 # 'git show-ref --heads' returns 1 when there are no branches
444 if ! git show-ref --heads -q; then
445 ref_param+=( --depth 1 )
446 else
447 fetch_command=( _git-r3_smart_fetch )
448 fi
449 fi
450
451 # now, another important thing. we may only fetch a remote
452 # branch directly to a local branch. Otherwise, we need to fetch
453 # the commit and re-create the branch on top of it.
454
455 if [[ ${ref[0]} ]]; then
456 if [[ ${is_branch} ]]; then
457 ref_param+=( -f "${remote_ref}:${local_id}/__main__" )
458 else
459 ref_param+=( "refs/tags/${remote_ref}" )
460 fi
461 fi
462
463 # if ${remote_ref} is branch or tag, ${ref[@]} will contain
464 # the respective commit id. otherwise, it will be an empty
465 # array, so the following won't evaluate to a parameter.
466 set -- "${fetch_command[@]}" --no-tags "${r}" "${ref_param[@]}"
467 echo "${@}" >&2
468 if "${@}"; then
469 if [[ ! ${is_branch} ]]; then
470 set -- git branch -f "${local_id}/__main__" \
471 "${ref[0]:-${remote_ref}}"
472 echo "${@}" >&2
473 if ! "${@}"; then
474 die "Creating branch for ${remote_ref} failed (wrong ref?)."
475 fi
476 fi
477
478 success=1
479 break
480 fi
481 done
482 [[ ${success} ]] || die "Unable to fetch from any of EGIT_REPO_URI"
483
484 # recursively fetch submodules
485 if git cat-file -e "${local_ref}":.gitmodules &>/dev/null; then
486 local submodules
487 _git-r3_set_submodules \
488 "$(git cat-file -p "${local_ref}":.gitmodules || die)"
489
490 while [[ ${submodules[@]} ]]; do
491 local subname=${submodules[0]}
492 local url=${submodules[1]}
493 local path=${submodules[2]}
494 local commit=$(git rev-parse "${local_ref}:${path}")
495
496 if [[ ! ${commit} ]]; then
497 die "Unable to get commit id for submodule ${subname}"
498 fi
499
500 git-r3_fetch "${url}" "${commit}" "${local_id}/${subname}"
501
502 submodules=( "${submodules[@]:3}" ) # shift
503 done
504 fi
505}
506
507# @FUNCTION: git-r3_checkout
508# @USAGE: [<repo-uri> [<checkout-path> [<local-id>]]]
509# @DESCRIPTION:
510# Check the previously fetched tree to the working copy.
511#
512# <repo-uri> specifies the repository URIs, as a space-separated list.
513# The first URI will be used as repository group identifier
514# and therefore must be used consistently with git-r3_fetch.
515# The remaining URIs are not used and therefore may be omitted.
516# When not specified, defaults to ${EGIT_REPO_URI}.
517#
518# <checkout-path> specifies the path to place the checkout. It defaults
519# to ${EGIT_CHECKOUT_DIR} if set, otherwise to ${WORKDIR}/${P}.
520#
521# <local-id> needs to specify the local identifier that was used
522# for respective git-r3_fetch.
523#
524# The checkout operation will write to the working copy, and export
525# the repository state into the environment. If the repository contains
526# submodules, they will be checked out recursively.
527git-r3_checkout() {
528 debug-print-function ${FUNCNAME} "$@"
529
530 if [[ $(declare -p EGIT_REPO_URI) != "declare -a"* ]]; then
531 local EGIT_REPO_URI=( ${EGIT_REPO_URI} )
532 fi
533
534 local repos=( "${1:-${EGIT_REPO_URI[@]}}" )
535 local out_dir=${2:-${EGIT_CHECKOUT_DIR:-${WORKDIR}/${P}}}
536 local local_id=${3:-${CATEGORY}/${PN}/${SLOT}}
537
538 local -x GIT_DIR GIT_WORK_TREE
539 _git-r3_set_gitdir "${repos[0]}"
540 GIT_WORK_TREE=${out_dir}
541 mkdir -p "${GIT_WORK_TREE}"
542
543 einfo "Checking out ${repos[0]} to ${out_dir} ..."
544
545 if ! git cat-file -e refs/heads/"${local_id}"/__main__
546 then
547 if [[ ${EVCS_OFFLINE} ]]; then
548 die "No local clone of ${repos[0]}. Unable to work with EVCS_OFFLINE."
549 else
550 die "Logic error: no local clone of ${repos[0]}. git-r3_fetch not used?"
551 fi
552 fi
553
554 set -- git checkout -f "${local_id}"/__main__ .
555 echo "${@}" >&2
556 "${@}" || die "git checkout ${local_id}/__main__ failed"
557
558 # diff against previous revision (if any)
559 local new_commit_id=$(git rev-parse --verify "${local_id}"/__main__)
560 local old_commit_id=$(
561 git rev-parse --verify "${local_id}"/__old__ 2>/dev/null
562 )
563
564 if [[ ! ${old_commit_id} ]]; then
565 echo "GIT NEW branch -->"
566 echo " repository: ${repos[0]}"
567 echo " at the commit: ${new_commit_id}"
568 else
569 echo "GIT update -->"
570 echo " repository: ${repos[0]}"
571 # write out message based on the revisions
572 if [[ "${old_commit_id}" != "${new_commit_id}" ]]; then
573 echo " updating from commit: ${old_commit_id}"
574 echo " to commit: ${new_commit_id}"
575
576 git --no-pager diff --stat \
577 ${old_commit_id}..${new_commit_id}
578 else
579 echo " at the commit: ${new_commit_id}"
580 fi
581 fi
582 git branch -f "${local_id}"/{__old__,__main__} || die
583
584 # recursively checkout submodules
585 if [[ -f ${GIT_WORK_TREE}/.gitmodules ]]; then
586 local submodules
587 _git-r3_set_submodules \
588 "$(<"${GIT_WORK_TREE}"/.gitmodules)"
589
590 while [[ ${submodules[@]} ]]; do
591 local subname=${submodules[0]}
592 local url=${submodules[1]}
593 local path=${submodules[2]}
594
595 git-r3_checkout "${url}" "${GIT_WORK_TREE}/${path}" \
596 "${local_id}/${subname}"
597
598 submodules=( "${submodules[@]:3}" ) # shift
599 done
600 fi
601
602 # keep this *after* submodules
603 export EGIT_DIR=${GIT_DIR}
604 export EGIT_VERSION=${new_commit_id}
605}
606
607# @FUNCTION: git-r3_peek_remote_ref
608# @USAGE: [<repo-uri> [<remote-ref>]]
609# @DESCRIPTION:
610# Peek the reference in the remote repository and print the matching
611# (newest) commit SHA1.
612#
613# <repo-uri> specifies the repository URIs to fetch from, as a space-
614# -separated list. When not specified, defaults to ${EGIT_REPO_URI}.
615#
616# <remote-ref> specifies the remote ref to peek. It is preferred to use
617# 'refs/heads/<branch-name>' for branches and 'refs/tags/<tag-name>'
618# for tags. Alternatively, 'HEAD' may be used for upstream default
619# branch. Defaults to the first of EGIT_COMMIT, EGIT_BRANCH or literal
620# 'HEAD' that is set to a non-null value.
621#
622# The operation will be done purely on the remote, without using local
623# storage. If commit SHA1 is provided as <remote-ref>, the function will
624# fail due to limitations of git protocol.
625#
626# On success, the function returns 0 and writes hexadecimal commit SHA1
627# to stdout. On failure, the function returns 1.
628git-r3_peek_remote_ref() {
629 debug-print-function ${FUNCNAME} "$@"
630
631 if [[ $(declare -p EGIT_REPO_URI) != "declare -a"* ]]; then
632 local EGIT_REPO_URI=( ${EGIT_REPO_URI} )
633 fi
634
635 local repos=( "${1:-${EGIT_REPO_URI[@]}}" )
636 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
637 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
638
639 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
640
641 local r success
642 for r in "${repos[@]}"; do
643 einfo "Peeking ${remote_ref} on ${r} ..." >&2
644
645 local is_branch lookup_ref
646 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]]
647 then
648 is_branch=1
649 lookup_ref=${remote_ref}
650 else
651 # ls-remote by commit is going to fail anyway,
652 # so we may as well pass refs/tags/ABCDEF...
653 lookup_ref=refs/tags/${remote_ref}
654 fi
655
656 # split on whitespace 792 # split on whitespace
657 local ref=( 793 local ref=(
658 $(git ls-remote "${r}" "${lookup_ref}") 794 $(git ls-remote "${r}" "${lookup_ref}")
659 ) 795 )
660 796
667 return 1 803 return 1
668} 804}
669 805
670git-r3_src_fetch() { 806git-r3_src_fetch() {
671 debug-print-function ${FUNCNAME} "$@" 807 debug-print-function ${FUNCNAME} "$@"
672
673 [[ ${EVCS_OFFLINE} ]] && return
674 808
675 if [[ ! ${EGIT3_STORE_DIR} && ${EGIT_STORE_DIR} ]]; then 809 if [[ ! ${EGIT3_STORE_DIR} && ${EGIT_STORE_DIR} ]]; then
676 ewarn "You have set EGIT_STORE_DIR but not EGIT3_STORE_DIR. Please consider" 810 ewarn "You have set EGIT_STORE_DIR but not EGIT3_STORE_DIR. Please consider"
677 ewarn "setting EGIT3_STORE_DIR for git-r3.eclass. It is recommended to use" 811 ewarn "setting EGIT3_STORE_DIR for git-r3.eclass. It is recommended to use"
678 ewarn "a different directory than EGIT_STORE_DIR to ease removing old clones" 812 ewarn "a different directory than EGIT_STORE_DIR to ease removing old clones"

Legend:
Removed from v.1.9  
changed lines
  Added in v.1.35

  ViewVC Help
Powered by ViewVC 1.1.20