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

  ViewVC Help
Powered by ViewVC 1.1.20