/[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.25 Revision 1.42
1# Copyright 1999-2014 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.25 2014/02/24 08:43:34 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.
27EXPORT_FUNCTIONS src_unpack 27EXPORT_FUNCTIONS src_unpack
28 28
29if [[ ! ${_GIT_R3} ]]; then 29if [[ ! ${_GIT_R3} ]]; then
30 30
31if [[ ! ${_INHERITED_BY_GIT_2} ]]; then 31if [[ ! ${_INHERITED_BY_GIT_2} ]]; then
32 DEPEND="dev-vcs/git" 32 DEPEND=">=dev-vcs/git-1.8.2.1"
33fi 33fi
34 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
35# @ECLASS-VARIABLE: EGIT3_STORE_DIR 89# @ECLASS-VARIABLE: EGIT3_STORE_DIR
36# @DESCRIPTION: 90# @DESCRIPTION:
37# Storage directory for git sources. 91# Storage directory for git sources.
38# 92#
93# This is intended to be set by user in make.conf. Ebuilds must not set
94# it.
95#
39# 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
40 111
41# @ECLASS-VARIABLE: EGIT_REPO_URI 112# @ECLASS-VARIABLE: EGIT_REPO_URI
42# @REQUIRED 113# @REQUIRED
43# @DESCRIPTION: 114# @DESCRIPTION:
44# 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
87# @DESCRIPTION: 158# @DESCRIPTION:
88# Set the eclass variables as necessary for operation. This can involve 159# Set the eclass variables as necessary for operation. This can involve
89# setting EGIT_* to defaults or ${PN}_LIVE_* variables. 160# setting EGIT_* to defaults or ${PN}_LIVE_* variables.
90_git-r3_env_setup() { 161_git-r3_env_setup() {
91 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
92 195
93 local esc_pn livevar 196 local esc_pn livevar
94 esc_pn=${PN//[-+]/_} 197 esc_pn=${PN//[-+]/_}
95 198
96 livevar=${esc_pn}_LIVE_REPO 199 livevar=${esc_pn}_LIVE_REPO
202 mkdir -m0755 -p "${EGIT3_STORE_DIR}" || die 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 [[ -e ${GIT_DIR}/shallow ]]; then
208 einfo "${GIT_DIR} was a shallow clone, recreating..."
209 rm -r "${GIT_DIR}" || die
210 fi
211 if [[ ! -d ${GIT_DIR} ]]; then 310 if [[ ! -d ${GIT_DIR} ]]; then
212 mkdir "${GIT_DIR}" || die 311 mkdir "${GIT_DIR}" || die
213 git init --bare || die 312 git init --bare || die
214 fi 313 fi
215} 314}
265 local uri=${1} 364 local uri=${1}
266 365
267 [[ ${uri} == file://* || ${uri} == /* ]] 366 [[ ${uri} == file://* || ${uri} == /* ]]
268} 367}
269 368
369# @FUNCTION: _git-r3_find_head
370# @USAGE: <head-ref>
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} "$@"
378
379 local head_ref=${1}
380 local head_hash=$(git rev-parse --verify "${1}" || die)
381 local matching_ref
382
383 # TODO: some transports support peeking at symbolic remote refs
384 # find a way to use that rather than guessing
385
386 # (based on guess_remote_head() in git-1.9.0/remote.c)
387 local h ref
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
396 done
397
398 if [[ ! ${matching_ref} ]]; then
399 die "Unable to find a matching branch for remote HEAD (${head_hash})"
400 fi
401
402 echo "${matching_ref}"
403}
404
270# @FUNCTION: git-r3_fetch 405# @FUNCTION: git-r3_fetch
271# @USAGE: [<repo-uri> [<remote-ref> [<local-id>]]] 406# @USAGE: [<repo-uri> [<remote-ref> [<local-id>]]]
272# @DESCRIPTION: 407# @DESCRIPTION:
273# Fetch new commits to the local clone of repository. 408# Fetch new commits to the local clone of repository.
274# 409#
317 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset" 452 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
318 453
319 local -x GIT_DIR 454 local -x GIT_DIR
320 _git-r3_set_gitdir "${repos[0]}" 455 _git-r3_set_gitdir "${repos[0]}"
321 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
464
322 # try to fetch from the remote 465 # try to fetch from the remote
323 local r success 466 local r success
324 for r in "${repos[@]}"; do 467 for r in "${repos[@]}"; do
325 einfo "Fetching ${r} ..." 468 einfo "Fetching ${r} ..."
326 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
327 local fetch_command=( 499 fetch_command+=(
328 git fetch --prune "${r}" 500 --prune
329 # mirror the remote branches as local branches 501 # mirror the remote branches as local branches
330 "refs/heads/*:refs/heads/*" 502 "+refs/heads/*:refs/heads/*"
331 # pull tags explicitly in order to prune them properly 503 # pull tags explicitly in order to prune them properly
332 "refs/tags/*:refs/tags/*" 504 "+refs/tags/*:refs/tags/*"
333 # notes in case something needs them 505 # notes in case something needs them
334 "refs/notes/*:refs/notes/*" 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"
335 ) 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
336 578
337 set -- "${fetch_command[@]}" 579 set -- "${fetch_command[@]}"
338 echo "${@}" >&2 580 echo "${@}" >&2
339 if "${@}"; then 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
340 # now let's see what the user wants from us 604 # now let's see what the user wants from us
341 local full_remote_ref=$( 605 local full_remote_ref=$(
342 git rev-parse --verify --symbolic-full-name "${remote_ref}" 606 git rev-parse --verify --symbolic-full-name "${remote_ref}"
343 ) 607 )
344 608
360 break 624 break
361 fi 625 fi
362 done 626 done
363 [[ ${success} ]] || die "Unable to fetch from any of EGIT_REPO_URI" 627 [[ ${success} ]] || die "Unable to fetch from any of EGIT_REPO_URI"
364 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
365 # recursively fetch submodules 633 # recursively fetch submodules
366 if git cat-file -e "${local_ref}":.gitmodules &>/dev/null; then 634 if git cat-file -e "${local_ref}":.gitmodules &>/dev/null; then
367 local submodules 635 local submodules
368 _git-r3_set_submodules \ 636 _git-r3_set_submodules \
369 "$(git cat-file -p "${local_ref}":.gitmodules || die)" 637 "$(git cat-file -p "${local_ref}":.gitmodules || die)"
442 ) 710 )
443 local new_commit_id=$( 711 local new_commit_id=$(
444 git rev-parse --verify refs/git-r3/"${local_id}"/__main__ 712 git rev-parse --verify refs/git-r3/"${local_id}"/__main__
445 ) 713 )
446 714
447 set -- git clone --quiet --shared --no-checkout "${GIT_DIR}" "${out_dir}"/
448 echo "${@}" >&2
449 "${@}" || die "git clone (for checkout) failed"
450
451 git-r3_sub_checkout() { 715 git-r3_sub_checkout() {
452 local orig_repo=${GIT_DIR} 716 local orig_repo=${GIT_DIR}
453 local -x GIT_DIR=${out_dir}/.git 717 local -x GIT_DIR=${out_dir}/.git
454 local -x GIT_WORK_TREE=${out_dir} 718 local -x GIT_WORK_TREE=${out_dir}
455 719
456 # pull notes 720 mkdir -p "${out_dir}" || die
457 git fetch "${orig_repo}" "refs/notes/*:refs/notes/*" || 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
458 738
459 set -- git checkout --quiet 739 set -- git checkout --quiet
460 if [[ ${remote_ref} ]]; then 740 if [[ ${remote_ref} ]]; then
461 set -- "${@}" "${remote_ref#refs/heads/}" 741 set -- "${@}" "${remote_ref#refs/heads/}"
462 else 742 else

Legend:
Removed from v.1.25  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20