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

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

  ViewVC Help
Powered by ViewVC 1.1.20