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

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

  ViewVC Help
Powered by ViewVC 1.1.20