/[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.4 Revision 1.30
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.4 2013/09/13 15:04:36 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/git-r3.eclass,v 1.30 2014/03/02 11:46:42 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"
33fi
34
32# @ECLASS-VARIABLE: EGIT3_STORE_DIR 35# @ECLASS-VARIABLE: EGIT3_STORE_DIR
33# @DESCRIPTION: 36# @DESCRIPTION:
34# Storage directory for git sources. 37# Storage directory for git sources.
35# 38#
39# This is intended to be set by user in make.conf. Ebuilds must not set
40# it.
41#
36# EGIT3_STORE_DIR=${DISTDIR}/git3-src 42# EGIT3_STORE_DIR=${DISTDIR}/git3-src
43
44# @ECLASS-VARIABLE: EGIT_MIRROR_URI
45# @DEFAULT_UNSET
46# @DESCRIPTION:
47# 'Top' URI to a local git mirror. If specified, the eclass will try
48# to fetch from the local mirror instead of using the remote repository.
49#
50# The mirror needs to follow EGIT3_STORE_DIR structure. The directory
51# created by eclass can be used for that purpose.
52#
53# Example:
54# @CODE
55# EGIT_MIRROR_URI="git://mirror.lan/"
56# @CODE
37 57
38# @ECLASS-VARIABLE: EGIT_REPO_URI 58# @ECLASS-VARIABLE: EGIT_REPO_URI
39# @REQUIRED 59# @REQUIRED
40# @DESCRIPTION: 60# @DESCRIPTION:
41# URIs to the repository, e.g. git://foo, https://foo. If multiple URIs 61# URIs to the repository, e.g. git://foo, https://foo. If multiple URIs
42# are provided, the eclass will consider them as fallback URIs to try 62# are provided, the eclass will consider them as fallback URIs to try
43# if the first URI does not work. 63# if the first URI does not work.
44# 64#
45# It can be overriden via env using ${PN}_LIVE_REPO variable. 65# It can be overriden via env using ${PN}_LIVE_REPO variable.
66#
67# Can be a whitespace-separated list or an array.
46# 68#
47# Example: 69# Example:
48# @CODE 70# @CODE
49# EGIT_REPO_URI="git://a/b.git https://c/d.git" 71# EGIT_REPO_URI="git://a/b.git https://c/d.git"
50# @CODE 72# @CODE
74# @ECLASS-VARIABLE: EGIT_CHECKOUT_DIR 96# @ECLASS-VARIABLE: EGIT_CHECKOUT_DIR
75# @DESCRIPTION: 97# @DESCRIPTION:
76# The directory to check the git sources out to. 98# The directory to check the git sources out to.
77# 99#
78# EGIT_CHECKOUT_DIR=${WORKDIR}/${P} 100# EGIT_CHECKOUT_DIR=${WORKDIR}/${P}
79
80# @ECLASS-VARIABLE: EGIT_NONSHALLOW
81# @DEFAULT_UNSET
82# @DESCRIPTION:
83# Disable performing shallow fetches/clones. Shallow clones have
84# a fair number of limitations. Therefore, if you'd like the eclass to
85# perform complete clones instead, set this to a non-null value.
86#
87# This variable is to be set in make.conf. Ebuilds are not allowed
88# to set it.
89 101
90# @FUNCTION: _git-r3_env_setup 102# @FUNCTION: _git-r3_env_setup
91# @INTERNAL 103# @INTERNAL
92# @DESCRIPTION: 104# @DESCRIPTION:
93# Set the eclass variables as necessary for operation. This can involve 105# Set the eclass variables as necessary for operation. This can involve
169_git-r3_set_gitdir() { 181_git-r3_set_gitdir() {
170 debug-print-function ${FUNCNAME} "$@" 182 debug-print-function ${FUNCNAME} "$@"
171 183
172 local repo_name=${1#*://*/} 184 local repo_name=${1#*://*/}
173 185
186 # strip the trailing slash
187 repo_name=${repo_name%/}
188
174 # strip common prefixes to make paths more likely to match 189 # strip common prefixes to make paths more likely to match
175 # e.g. git://X/Y.git vs https://X/git/Y.git 190 # e.g. git://X/Y.git vs https://X/git/Y.git
176 # (but just one of the prefixes) 191 # (but just one of the prefixes)
177 case "${repo_name}" in 192 case "${repo_name}" in
193 # gnome.org... who else?
194 browse/*) repo_name=${repo_name#browse/};;
178 # cgit can proxy requests to git 195 # cgit can proxy requests to git
179 cgit/*) repo_name=${repo_name#cgit/};; 196 cgit/*) repo_name=${repo_name#cgit/};;
180 # pretty common 197 # pretty common
181 git/*) repo_name=${repo_name#git/};; 198 git/*) repo_name=${repo_name#git/};;
182 # gentoo.org 199 # gentoo.org
197 GIT_DIR=${EGIT3_STORE_DIR}/${repo_name} 214 GIT_DIR=${EGIT3_STORE_DIR}/${repo_name}
198 215
199 if [[ ! -d ${EGIT3_STORE_DIR} ]]; then 216 if [[ ! -d ${EGIT3_STORE_DIR} ]]; then
200 ( 217 (
201 addwrite / 218 addwrite /
202 mkdir -m0755 -p "${EGIT3_STORE_DIR}" 219 mkdir -m0755 -p "${EGIT3_STORE_DIR}" || die
203 ) || die "Unable to create ${EGIT3_STORE_DIR}" 220 ) || die "Unable to create ${EGIT3_STORE_DIR}"
204 fi 221 fi
205 222
206 addwrite "${EGIT3_STORE_DIR}" 223 addwrite "${EGIT3_STORE_DIR}"
224 if [[ -e ${GIT_DIR}/shallow ]]; then
225 einfo "${GIT_DIR} was a shallow clone, recreating..."
226 rm -r "${GIT_DIR}" || die
227 fi
207 if [[ ! -d ${GIT_DIR} ]]; then 228 if [[ ! -d ${GIT_DIR} ]]; then
208 mkdir "${GIT_DIR}" || die 229 mkdir "${GIT_DIR}" || die
209 git init --bare || die 230 git init --bare || die
210
211 # avoid auto-unshallow :)
212 touch "${GIT_DIR}"/shallow || die
213 fi 231 fi
214} 232}
215 233
216# @FUNCTION: _git-r3_set_submodules 234# @FUNCTION: _git-r3_set_submodules
217# @USAGE: <file-contents> 235# @USAGE: <file-contents>
235 [[ ${l} == submodule.*.url=* ]] || continue 253 [[ ${l} == submodule.*.url=* ]] || continue
236 254
237 l=${l#submodule.} 255 l=${l#submodule.}
238 local subname=${l%%.url=*} 256 local subname=${l%%.url=*}
239 257
258 # skip modules that have 'update = none', bug #487262.
259 local upd=$(echo "${data}" | git config -f /dev/fd/0 \
260 submodule."${subname}".update)
261 [[ ${upd} == none ]] && continue
262
240 submodules+=( 263 submodules+=(
241 "${subname}" 264 "${subname}"
242 "$(echo "${data}" | git config -f /dev/fd/0 \ 265 "$(echo "${data}" | git config -f /dev/fd/0 \
243 submodule."${subname}".url)" 266 submodule."${subname}".url || die)"
244 "$(echo "${data}" | git config -f /dev/fd/0 \ 267 "$(echo "${data}" | git config -f /dev/fd/0 \
245 submodule."${subname}".path)" 268 submodule."${subname}".path || die)"
246 ) 269 )
247 done < <(echo "${data}" | git config -f /dev/fd/0 -l) 270 done < <(echo "${data}" | git config -f /dev/fd/0 -l || die)
248} 271}
249 272
273# @FUNCTION: _git-r3_is_local_repo
274# @USAGE: <repo-uri>
275# @INTERNAL
276# @DESCRIPTION:
277# Determine whether the given URI specifies a local (on-disk)
278# repository.
279_git-r3_is_local_repo() {
280 debug-print-function ${FUNCNAME} "$@"
281
282 local uri=${1}
283
284 [[ ${uri} == file://* || ${uri} == /* ]]
285}
286
250# @FUNCTION: _git-r3_smart_fetch 287# @FUNCTION: _git-r3_update_head
251# @USAGE: <git-fetch-args>... 288# @USAGE: <remote-head-ref>
289# @INTERNAL
252# @DESCRIPTION: 290# @DESCRIPTION:
253# Try fetching without '--depth' and switch to '--depth 1' if that 291# Given a ref to which remote HEAD was fetched, try to match
254# will involve less objects fetched. 292# a local branch and update symbolic HEAD appropriately.
255_git-r3_smart_fetch() { 293_git-r3_update_head()
294{
256 debug-print-function ${FUNCNAME} "$@" 295 debug-print-function ${FUNCNAME} "$@"
257 296
258 local sed_regexp='.*Counting objects: \([0-9]*\), done\..*' 297 local head_ref=${1}
298 local head_hash=$(git rev-parse --verify "${1}" || die)
299 local matching_ref
259 300
260 # start the main fetch 301 # TODO: some transports support peeking at symbolic remote refs
261 local cmd=( git fetch --progress "${@}" ) 302 # find a way to use that rather than guessing
262 echo "${cmd[@]}" >&2
263 303
264 # we copy the output to the 'sed' pipe for parsing. whenever sed finds 304 # (based on guess_remote_head() in git-1.9.0/remote.c)
265 # the process count, it quits quickly to avoid delays in writing it. 305 local h ref
266 # then, we start a dummy 'cat' to keep the pipe alive 306 while read h ref; do
267 307 # look for matching head
268 "${cmd[@]}" 2>&1 \ 308 if [[ ${h} == ${head_hash} ]]; then
269 | tee >( 309 # either take the first matching ref, or master if it is there
270 sed -n -e "/${sed_regexp}/{s/${sed_regexp}/\1/p;q}" \ 310 if [[ ! ${matching_ref} || ${ref} == refs/heads/master ]]; then
271 > "${T}"/git-r3_main.count 311 matching_ref=${ref}
272 exec cat >/dev/null 312 fi
273 ) &
274 local main_pid=${!}
275
276 # start the helper process
277 _git-r3_sub_fetch() {
278 # wait for main fetch to get object count; if the server doesn't
279 # output it, we won't even launch the parallel process
280 while [[ ! -s ${T}/git-r3_main.count ]]; do
281 sleep 0.25
282 done
283
284 # ok, let's see if parallel fetch gives us smaller count
285 # --dry-run will prevent it from writing to the local clone
286 # and sed should terminate git with SIGPIPE
287 local sub_count=$(git fetch --progress --dry-run --depth 1 "${@}" 2>&1 \
288 | sed -n -e "/${sed_regexp}/{s/${sed_regexp}/\1/p;q}")
289 local main_count=$(<"${T}"/git-r3_main.count)
290
291 # let's be real sure that '--depth 1' will be good for us.
292 # note that we have purely objects counts, and '--depth 1'
293 # may involve much bigger objects
294 if [[ ${main_count} && ${main_count} -ge $(( sub_count * 3/2 )) ]]
295 then
296 # signal that we want shallow fetch instead,
297 # and terminate the non-shallow fetch process
298 touch "${T}"/git-r3_want_shallow || die
299 kill ${main_pid} &>/dev/null
300 exit 0
301 fi 313 fi
314 done < <(git show-ref --heads || die)
302 315
303 exit 1 316 if [[ ! ${matching_ref} ]]; then
304 } 317 die "Unable to find a matching branch for remote HEAD (${head_hash})"
305 _git-r3_sub_fetch "${@}" &
306 local sub_pid=${!}
307
308 # wait for main process to terminate, either of its own
309 # or by signal from subprocess
310 wait ${main_pid}
311 local main_ret=${?}
312
313 # wait for subprocess to terminate, killing it if necessary.
314 # if main fetch finished before it, there's no point in keeping
315 # it alive. if main fetch was killed by it, it's done anyway
316 kill ${sub_pid} &>/dev/null
317 wait ${sub_pid}
318
319 # now see if subprocess wanted to tell us something...
320 if [[ -f ${T}/git-r3_want_shallow ]]; then
321 rm "${T}"/git-r3_want_shallow || die
322
323 # if fetch finished already (wasn't killed), ignore it
324 [[ ${main_ret} -eq 0 ]] && return 0
325
326 # otherwise, restart as shallow fetch
327 einfo "Restarting fetch using --depth 1 to save bandwidth ..."
328 local cmd=( git fetch --progress --depth 1 "${@}" )
329 echo "${cmd[@]}" >&2
330 "${cmd[@]}"
331 main_ret=${?}
332 fi 318 fi
333 319
334 return ${main_ret} 320 git symbolic-ref HEAD "${matching_ref}" || die
335} 321}
336 322
337# @FUNCTION: git-r3_fetch 323# @FUNCTION: git-r3_fetch
338# @USAGE: [<repo-uri> [<remote-ref> [<local-id>]]] 324# @USAGE: [<repo-uri> [<remote-ref> [<local-id>]]]
339# @DESCRIPTION: 325# @DESCRIPTION:
352# is set to a non-null value. 338# is set to a non-null value.
353# 339#
354# <local-id> specifies the local branch identifier that will be used to 340# <local-id> specifies the local branch identifier that will be used to
355# locally store the fetch result. It should be unique to multiple 341# locally store the fetch result. It should be unique to multiple
356# fetches within the repository that can be performed at the same time 342# fetches within the repository that can be performed at the same time
357# (including parallel merges). It defaults to ${CATEGORY}/${PN}/${SLOT}. 343# (including parallel merges). It defaults to ${CATEGORY}/${PN}/${SLOT%/*}.
358# This default should be fine unless you are fetching multiple trees 344# This default should be fine unless you are fetching multiple trees
359# from the same repository in the same ebuild. 345# from the same repository in the same ebuild.
360# 346#
361# The fetch operation will affect the EGIT_STORE only. It will not touch 347# The fetch operation will affect the EGIT_STORE only. It will not touch
362# the working copy, nor export any environment variables. 348# the working copy, nor export any environment variables.
363# If the repository contains submodules, they will be fetched 349# If the repository contains submodules, they will be fetched
364# recursively. 350# recursively.
365git-r3_fetch() { 351git-r3_fetch() {
366 debug-print-function ${FUNCNAME} "$@" 352 debug-print-function ${FUNCNAME} "$@"
367 353
354 [[ ${EVCS_OFFLINE} ]] && return
355
356 local repos
357 if [[ ${1} ]]; then
358 repos=( ${1} )
359 elif [[ $(declare -p EGIT_REPO_URI) == "declare -a"* ]]; then
360 repos=( "${EGIT_REPO_URI[@]}" )
361 else
368 local repos=( ${1:-${EGIT_REPO_URI}} ) 362 repos=( ${EGIT_REPO_URI} )
363 fi
364
369 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}} 365 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
370 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}} 366 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
371 local local_id=${3:-${CATEGORY}/${PN}/${SLOT}} 367 local local_id=${3:-${CATEGORY}/${PN}/${SLOT%/*}}
372 local local_ref=refs/heads/${local_id}/__main__ 368 local local_ref=refs/git-r3/${local_id}/__main__
373 369
374 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset" 370 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
375 371
376 local -x GIT_DIR 372 local -x GIT_DIR
377 _git-r3_set_gitdir ${repos[0]} 373 _git-r3_set_gitdir "${repos[0]}"
374
375 # prepend the local mirror if applicable
376 if [[ ${EGIT_MIRROR_URI} ]]; then
377 repos=(
378 "${EGIT_MIRROR_URI%/}/${GIT_DIR##*/}"
379 "${repos[@]}"
380 )
381 fi
378 382
379 # try to fetch from the remote 383 # try to fetch from the remote
380 local r success 384 local r success
381 for r in ${repos[@]}; do 385 for r in "${repos[@]}"; do
386 einfo "Fetching ${r} ..."
387
388 local fetch_command=(
389 git fetch --prune "${r}"
390 # mirror the remote branches as local branches
391 "refs/heads/*:refs/heads/*"
392 # pull tags explicitly in order to prune them properly
393 "refs/tags/*:refs/tags/*"
394 # notes in case something needs them
395 "refs/notes/*:refs/notes/*"
396 # and HEAD in case we need the default branch
397 # (we keep it in refs/git-r3 since otherwise --prune interferes)
398 HEAD:refs/git-r3/HEAD
399 )
400
401 set -- "${fetch_command[@]}"
402 echo "${@}" >&2
403 if "${@}"; then
404 # find remote HEAD and update our HEAD properly
405 _git-r3_update_head refs/git-r3/HEAD
406
407 # now let's see what the user wants from us
408 local full_remote_ref=$(
409 git rev-parse --verify --symbolic-full-name "${remote_ref}"
410 )
411
412 if [[ ${full_remote_ref} ]]; then
413 # when we are given a ref, create a symbolic ref
414 # so that we preserve the actual argument
415 set -- git symbolic-ref "${local_ref}" "${full_remote_ref}"
416 else
417 # otherwise, we were likely given a commit id
418 set -- git update-ref --no-deref "${local_ref}" "${remote_ref}"
419 fi
420
421 echo "${@}" >&2
422 if ! "${@}"; then
423 die "Referencing ${remote_ref} failed (wrong ref?)."
424 fi
425
426 success=1
427 break
428 fi
429 done
430 [[ ${success} ]] || die "Unable to fetch from any of EGIT_REPO_URI"
431
432 # recursively fetch submodules
433 if git cat-file -e "${local_ref}":.gitmodules &>/dev/null; then
434 local submodules
435 _git-r3_set_submodules \
436 "$(git cat-file -p "${local_ref}":.gitmodules || die)"
437
438 while [[ ${submodules[@]} ]]; do
439 local subname=${submodules[0]}
440 local url=${submodules[1]}
441 local path=${submodules[2]}
442 local commit=$(git rev-parse "${local_ref}:${path}")
443
444 if [[ ! ${commit} ]]; then
445 die "Unable to get commit id for submodule ${subname}"
446 fi
447 if [[ ${url} == ./* || ${url} == ../* ]]; then
448 local subrepos=( "${repos[@]/%//${url}}" )
449 else
450 local subrepos=( "${url}" )
451 fi
452
453 git-r3_fetch "${subrepos[*]}" "${commit}" "${local_id}/${subname}"
454
455 submodules=( "${submodules[@]:3}" ) # shift
456 done
457 fi
458}
459
460# @FUNCTION: git-r3_checkout
461# @USAGE: [<repo-uri> [<checkout-path> [<local-id>]]]
462# @DESCRIPTION:
463# Check the previously fetched tree to the working copy.
464#
465# <repo-uri> specifies the repository URIs, as a space-separated list.
466# The first URI will be used as repository group identifier
467# and therefore must be used consistently with git-r3_fetch.
468# The remaining URIs are not used and therefore may be omitted.
469# When not specified, defaults to ${EGIT_REPO_URI}.
470#
471# <checkout-path> specifies the path to place the checkout. It defaults
472# to ${EGIT_CHECKOUT_DIR} if set, otherwise to ${WORKDIR}/${P}.
473#
474# <local-id> needs to specify the local identifier that was used
475# for respective git-r3_fetch.
476#
477# The checkout operation will write to the working copy, and export
478# the repository state into the environment. If the repository contains
479# submodules, they will be checked out recursively.
480git-r3_checkout() {
481 debug-print-function ${FUNCNAME} "$@"
482
483 local repos
484 if [[ ${1} ]]; then
485 repos=( ${1} )
486 elif [[ $(declare -p EGIT_REPO_URI) == "declare -a"* ]]; then
487 repos=( "${EGIT_REPO_URI[@]}" )
488 else
489 repos=( ${EGIT_REPO_URI} )
490 fi
491
492 local out_dir=${2:-${EGIT_CHECKOUT_DIR:-${WORKDIR}/${P}}}
493 local local_id=${3:-${CATEGORY}/${PN}/${SLOT%/*}}
494
495 local -x GIT_DIR
496 _git-r3_set_gitdir "${repos[0]}"
497
498 einfo "Checking out ${repos[0]} to ${out_dir} ..."
499
500 if ! git cat-file -e refs/git-r3/"${local_id}"/__main__; then
501 if [[ ${EVCS_OFFLINE} ]]; then
502 die "No local clone of ${repos[0]}. Unable to work with EVCS_OFFLINE."
503 else
504 die "Logic error: no local clone of ${repos[0]}. git-r3_fetch not used?"
505 fi
506 fi
507 local remote_ref=$(
508 git symbolic-ref --quiet refs/git-r3/"${local_id}"/__main__
509 )
510 local new_commit_id=$(
511 git rev-parse --verify refs/git-r3/"${local_id}"/__main__
512 )
513
514 git-r3_sub_checkout() {
515 local orig_repo=${GIT_DIR}
516 local -x GIT_DIR=${out_dir}/.git
517 local -x GIT_WORK_TREE=${out_dir}
518
519 mkdir -p "${out_dir}" || die
520
521 # use git init+fetch instead of clone since the latter doesn't like
522 # non-empty directories.
523
524 git init --quiet || die
525 # setup 'alternates' to avoid copying objects
526 echo "${orig_repo}/objects" > "${GIT_DIR}"/objects/info/alternates || die
527 # now copy the refs
528 # [htn]* safely catches heads, tags, notes without complaining
529 # on non-existing ones, and omits internal 'git-r3' ref
530 cp -R "${orig_repo}"/refs/[htn]* "${GIT_DIR}"/refs/ || die
531
532 # (no need to copy HEAD, we will set it via checkout)
533
534 set -- git checkout --quiet
535 if [[ ${remote_ref} ]]; then
536 set -- "${@}" "${remote_ref#refs/heads/}"
537 else
538 set -- "${@}" "${new_commit_id}"
539 fi
540 echo "${@}" >&2
541 "${@}" || die "git checkout ${remote_ref:-${new_commit_id}} failed"
542 }
543 git-r3_sub_checkout
544
545 local old_commit_id=$(
546 git rev-parse --quiet --verify refs/git-r3/"${local_id}"/__old__
547 )
548 if [[ ! ${old_commit_id} ]]; then
549 echo "GIT NEW branch -->"
550 echo " repository: ${repos[0]}"
551 echo " at the commit: ${new_commit_id}"
552 else
553 # diff against previous revision
554 echo "GIT update -->"
555 echo " repository: ${repos[0]}"
556 # write out message based on the revisions
557 if [[ "${old_commit_id}" != "${new_commit_id}" ]]; then
558 echo " updating from commit: ${old_commit_id}"
559 echo " to commit: ${new_commit_id}"
560
561 git --no-pager diff --stat \
562 ${old_commit_id}..${new_commit_id}
563 else
564 echo " at the commit: ${new_commit_id}"
565 fi
566 fi
567 git update-ref --no-deref refs/git-r3/"${local_id}"/{__old__,__main__} || die
568
569 # recursively checkout submodules
570 if [[ -f ${out_dir}/.gitmodules ]]; then
571 local submodules
572 _git-r3_set_submodules \
573 "$(<"${out_dir}"/.gitmodules)"
574
575 while [[ ${submodules[@]} ]]; do
576 local subname=${submodules[0]}
577 local url=${submodules[1]}
578 local path=${submodules[2]}
579
580 if [[ ${url} == ./* || ${url} == ../* ]]; then
581 url=${repos[0]%%/}/${url}
582 fi
583
584 git-r3_checkout "${url}" "${out_dir}/${path}" \
585 "${local_id}/${subname}"
586
587 submodules=( "${submodules[@]:3}" ) # shift
588 done
589 fi
590
591 # keep this *after* submodules
592 export EGIT_DIR=${GIT_DIR}
593 export EGIT_VERSION=${new_commit_id}
594}
595
596# @FUNCTION: git-r3_peek_remote_ref
597# @USAGE: [<repo-uri> [<remote-ref>]]
598# @DESCRIPTION:
599# Peek the reference in the remote repository and print the matching
600# (newest) commit SHA1.
601#
602# <repo-uri> specifies the repository URIs to fetch from, as a space-
603# -separated list. When not specified, defaults to ${EGIT_REPO_URI}.
604#
605# <remote-ref> specifies the remote ref to peek. It is preferred to use
606# 'refs/heads/<branch-name>' for branches and 'refs/tags/<tag-name>'
607# for tags. Alternatively, 'HEAD' may be used for upstream default
608# branch. Defaults to the first of EGIT_COMMIT, EGIT_BRANCH or literal
609# 'HEAD' that is set to a non-null value.
610#
611# The operation will be done purely on the remote, without using local
612# storage. If commit SHA1 is provided as <remote-ref>, the function will
613# fail due to limitations of git protocol.
614#
615# On success, the function returns 0 and writes hexadecimal commit SHA1
616# to stdout. On failure, the function returns 1.
617git-r3_peek_remote_ref() {
618 debug-print-function ${FUNCNAME} "$@"
619
620 local repos
621 if [[ ${1} ]]; then
622 repos=( ${1} )
623 elif [[ $(declare -p EGIT_REPO_URI) == "declare -a"* ]]; then
624 repos=( "${EGIT_REPO_URI[@]}" )
625 else
626 repos=( ${EGIT_REPO_URI} )
627 fi
628
629 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
630 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
631
632 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
633
634 local r success
635 for r in "${repos[@]}"; do
382 einfo "Fetching ${remote_ref} from ${r} ..." 636 einfo "Peeking ${remote_ref} on ${r} ..." >&2
383 637
384 local is_branch lookup_ref 638 local is_branch lookup_ref
385 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]] 639 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]]
386 then 640 then
387 is_branch=1 641 is_branch=1
390 # ls-remote by commit is going to fail anyway, 644 # ls-remote by commit is going to fail anyway,
391 # so we may as well pass refs/tags/ABCDEF... 645 # so we may as well pass refs/tags/ABCDEF...
392 lookup_ref=refs/tags/${remote_ref} 646 lookup_ref=refs/tags/${remote_ref}
393 fi 647 fi
394 648
395 # first, try ls-remote to see if ${remote_ref} is a real ref
396 # and not a commit id. if it succeeds, we can pass ${remote_ref}
397 # to 'fetch'. otherwise, we will just fetch everything
398
399 # split on whitespace
400 local ref=(
401 $(git ls-remote "${r}" "${lookup_ref}")
402 )
403
404 local nonshallow=${EGIT_NONSHALLOW}
405 local ref_param=()
406 if [[ ! ${ref[0]} ]]; then
407 nonshallow=1
408 fi
409
410 # 1. if we need a non-shallow clone and we have a shallow one,
411 # we need to unshallow it explicitly.
412 # 2. if we want a shallow clone, we just pass '--depth 1'
413 # to the first fetch in the repo. passing '--depth'
414 # to further requests usually results in more data being
415 # downloaded than without it.
416 # 3. if we update a shallow clone, we try without '--depth'
417 # first since that usually transfers less data. however,
418 # we use git-r3_smart_fetch that can switch into '--depth 1'
419 # if that looks beneficial.
420
421 local fetch_command=( git fetch )
422 if [[ ${nonshallow} ]]; then
423 if [[ -f ${GIT_DIR}/shallow ]]; then
424 ref_param+=( --unshallow )
425 fi
426 else
427 # 'git show-ref --heads' returns 1 when there are no branches
428 if ! git show-ref --heads -q; then
429 ref_param+=( --depth 1 )
430 else
431 fetch_command=( _git-r3_smart_fetch )
432 fi
433 fi
434
435 # now, another important thing. we may only fetch a remote
436 # branch directly to a local branch. Otherwise, we need to fetch
437 # the commit and re-create the branch on top of it.
438
439 if [[ ${ref[0]} ]]; then
440 if [[ ${is_branch} ]]; then
441 ref_param+=( -f "${remote_ref}:${local_id}/__main__" )
442 else
443 ref_param+=( "refs/tags/${remote_ref}" )
444 fi
445 fi
446
447 # if ${remote_ref} is branch or tag, ${ref[@]} will contain
448 # the respective commit id. otherwise, it will be an empty
449 # array, so the following won't evaluate to a parameter.
450 set -- "${fetch_command[@]}" --no-tags "${r}" "${ref_param[@]}"
451 echo "${@}" >&2
452 if "${@}"; then
453 if [[ ! ${is_branch} ]]; then
454 set -- git branch -f "${local_id}/__main__" \
455 "${ref[0]:-${remote_ref}}"
456 echo "${@}" >&2
457 if ! "${@}"; then
458 die "Creating branch for ${remote_ref} failed (wrong ref?)."
459 fi
460 fi
461
462 success=1
463 break
464 fi
465 done
466 [[ ${success} ]] || die "Unable to fetch from any of EGIT_REPO_URI"
467
468 # recursively fetch submodules
469 if git cat-file -e "${local_ref}":.gitmodules &>/dev/null; then
470 local submodules
471 _git-r3_set_submodules \
472 "$(git cat-file -p "${local_ref}":.gitmodules || die)"
473
474 while [[ ${submodules[@]} ]]; do
475 local subname=${submodules[0]}
476 local url=${submodules[1]}
477 local path=${submodules[2]}
478 local commit=$(git rev-parse "${local_ref}:${path}")
479
480 if [[ ! ${commit} ]]; then
481 die "Unable to get commit id for submodule ${subname}"
482 fi
483
484 git-r3_fetch "${url}" "${commit}" "${local_id}/${subname}"
485
486 submodules=( "${submodules[@]:3}" ) # shift
487 done
488 fi
489}
490
491# @FUNCTION: git-r3_checkout
492# @USAGE: [<repo-uri> [<checkout-path> [<local-id>]]]
493# @DESCRIPTION:
494# Check the previously fetched tree to the working copy.
495#
496# <repo-uri> specifies the repository URIs, as a space-separated list.
497# The first URI will be used as repository group identifier
498# and therefore must be used consistently with git-r3_fetch.
499# The remaining URIs are not used and therefore may be omitted.
500# When not specified, defaults to ${EGIT_REPO_URI}.
501#
502# <checkout-path> specifies the path to place the checkout. It defaults
503# to ${EGIT_CHECKOUT_DIR} if set, otherwise to ${WORKDIR}/${P}.
504#
505# <local-id> needs to specify the local identifier that was used
506# for respective git-r3_fetch.
507#
508# The checkout operation will write to the working copy, and export
509# the repository state into the environment. If the repository contains
510# submodules, they will be checked out recursively.
511git-r3_checkout() {
512 debug-print-function ${FUNCNAME} "$@"
513
514 local repos=( ${1:-${EGIT_REPO_URI}} )
515 local out_dir=${2:-${EGIT_CHECKOUT_DIR:-${WORKDIR}/${P}}}
516 local local_id=${3:-${CATEGORY}/${PN}/${SLOT}}
517
518 local -x GIT_DIR GIT_WORK_TREE
519 _git-r3_set_gitdir ${repos[0]}
520 GIT_WORK_TREE=${out_dir}
521 mkdir -p "${GIT_WORK_TREE}"
522
523 einfo "Checking out ${repos[0]} to ${out_dir} ..."
524
525 if ! git cat-file -e refs/heads/"${local_id}"/__main__
526 then
527 if [[ ${EVCS_OFFLINE} ]]; then
528 die "No local clone of ${repos[0]}. Unable to work with EVCS_OFFLINE."
529 else
530 die "Logic error: no local clone of ${repos[0]}. git-r3_fetch not used?"
531 fi
532 fi
533
534 set -- git checkout -f "${local_id}"/__main__ .
535 echo "${@}" >&2
536 "${@}" || die "git checkout ${local_id}/__main__ failed"
537
538 # diff against previous revision (if any)
539 local new_commit_id=$(git rev-parse --verify "${local_id}"/__main__)
540 local old_commit_id=$(
541 git rev-parse --verify "${local_id}"/__old__ 2>/dev/null
542 )
543
544 if [[ ! ${old_commit_id} ]]; then
545 echo "GIT NEW branch -->"
546 echo " repository: ${repos[0]}"
547 echo " at the commit: ${new_commit_id}"
548 else
549 echo "GIT update -->"
550 echo " repository: ${repos[0]}"
551 # write out message based on the revisions
552 if [[ "${old_commit_id}" != "${new_commit_id}" ]]; then
553 echo " updating from commit: ${old_commit_id}"
554 echo " to commit: ${new_commit_id}"
555
556 git --no-pager diff --stat \
557 ${old_commit_id}..${new_commit_id}
558 else
559 echo " at the commit: ${new_commit_id}"
560 fi
561 fi
562 git branch -f "${local_id}"/{__old__,__main__} || die
563
564 # recursively checkout submodules
565 if [[ -f ${GIT_WORK_TREE}/.gitmodules ]]; then
566 local submodules
567 _git-r3_set_submodules \
568 "$(<"${GIT_WORK_TREE}"/.gitmodules)"
569
570 while [[ ${submodules[@]} ]]; do
571 local subname=${submodules[0]}
572 local url=${submodules[1]}
573 local path=${submodules[2]}
574
575 git-r3_checkout "${url}" "${GIT_WORK_TREE}/${path}" \
576 "${local_id}/${subname}"
577
578 submodules=( "${submodules[@]:3}" ) # shift
579 done
580 fi
581
582 # keep this *after* submodules
583 export EGIT_DIR=${GIT_DIR}
584 export EGIT_VERSION=${new_commit_id}
585}
586
587# @FUNCTION: git-r3_peek_remote_ref
588# @USAGE: [<repo-uri> [<remote-ref>]]
589# @DESCRIPTION:
590# Peek the reference in the remote repository and print the matching
591# (newest) commit SHA1.
592#
593# <repo-uri> specifies the repository URIs to fetch from, as a space-
594# -separated list. When not specified, defaults to ${EGIT_REPO_URI}.
595#
596# <remote-ref> specifies the remote ref to peek. It is preferred to use
597# 'refs/heads/<branch-name>' for branches and 'refs/tags/<tag-name>'
598# for tags. Alternatively, 'HEAD' may be used for upstream default
599# branch. Defaults to the first of EGIT_COMMIT, EGIT_BRANCH or literal
600# 'HEAD' that is set to a non-null value.
601#
602# The operation will be done purely on the remote, without using local
603# storage. If commit SHA1 is provided as <remote-ref>, the function will
604# fail due to limitations of git protocol.
605#
606# On success, the function returns 0 and writes hexadecimal commit SHA1
607# to stdout. On failure, the function returns 1.
608git-r3_peek_remote_ref() {
609 debug-print-function ${FUNCNAME} "$@"
610
611 local repos=( ${1:-${EGIT_REPO_URI}} )
612 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
613 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
614
615 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
616
617 local r success
618 for r in ${repos[@]}; do
619 einfo "Peeking ${remote_ref} on ${r} ..." >&2
620
621 local is_branch lookup_ref
622 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]]
623 then
624 is_branch=1
625 lookup_ref=${remote_ref}
626 else
627 # ls-remote by commit is going to fail anyway,
628 # so we may as well pass refs/tags/ABCDEF...
629 lookup_ref=refs/tags/${remote_ref}
630 fi
631
632 # split on whitespace 649 # split on whitespace
633 local ref=( 650 local ref=(
634 $(git ls-remote "${r}" "${lookup_ref}") 651 $(git ls-remote "${r}" "${lookup_ref}")
635 ) 652 )
636 653
644} 661}
645 662
646git-r3_src_fetch() { 663git-r3_src_fetch() {
647 debug-print-function ${FUNCNAME} "$@" 664 debug-print-function ${FUNCNAME} "$@"
648 665
649 [[ ${EVCS_OFFLINE} ]] && return
650
651 if [[ ! ${EGIT3_STORE_DIR} && ${EGIT_STORE_DIR} ]]; then 666 if [[ ! ${EGIT3_STORE_DIR} && ${EGIT_STORE_DIR} ]]; then
652 ewarn "You have set EGIT_STORE_DIR but not EGIT3_STORE_DIR. Please consider" 667 ewarn "You have set EGIT_STORE_DIR but not EGIT3_STORE_DIR. Please consider"
653 ewarn "setting EGIT3_STORE_DIR for git-r3.eclass. It is recommended to use" 668 ewarn "setting EGIT3_STORE_DIR for git-r3.eclass. It is recommended to use"
654 ewarn "a different directory than EGIT_STORE_DIR to ease removing old clones" 669 ewarn "a different directory than EGIT_STORE_DIR to ease removing old clones"
655 ewarn "when git-2 eclass becomes deprecated." 670 ewarn "when git-2 eclass becomes deprecated."

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.30

  ViewVC Help
Powered by ViewVC 1.1.20