/[gentoo-x86]/eclass/git-r3.eclass
Gentoo

Contents of /eclass/git-r3.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations) (download)
Thu Sep 5 20:24:10 2013 UTC (12 months, 1 week ago) by mgorny
Branch: MAIN
Introduce the new git eclass.

1 # Copyright 1999-2013 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: $
4
5 # @ECLASS: git-r3.eclass
6 # @MAINTAINER:
7 # Michał Górny <mgorny@gentoo.org>
8 # @BLURB: Eclass for fetching and unpacking git repositories.
9 # @DESCRIPTION:
10 # Third generation eclass for easing maitenance of live ebuilds using
11 # git as remote repository. The eclass supports lightweight (shallow)
12 # clones and bare clones of submodules.
13
14 case "${EAPI:-0}" in
15 0|1|2|3|4|5)
16 ;;
17 *)
18 die "Unsupported EAPI=${EAPI} (unknown) for ${ECLASS}"
19 ;;
20 esac
21
22 if [[ ! ${_GIT_R3} ]]; then
23
24 inherit eutils
25
26 fi
27
28 EXPORT_FUNCTIONS src_unpack
29
30 if [[ ! ${_GIT_R3} ]]; then
31
32 # @ECLASS-VARIABLE: EGIT3_STORE_DIR
33 # @DESCRIPTION:
34 # Storage directory for git sources.
35 #
36 # EGIT3_STORE_DIR=${DISTDIR}/git3-src
37
38 # @ECLASS-VARIABLE: EGIT_REPO_URI
39 # @REQUIRED
40 # @DESCRIPTION:
41 # 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
43 # if the first URI does not work.
44 #
45 # It can be overriden via env using ${PN}_LIVE_REPO variable.
46 #
47 # Example:
48 # @CODE
49 # EGIT_REPO_URI="git://a/b.git https://c/d.git"
50 # @CODE
51
52 # @ECLASS-VARIABLE: EVCS_OFFLINE
53 # @DEFAULT_UNSET
54 # @DESCRIPTION:
55 # If non-empty, this variable prevents any online operations.
56
57 # @ECLASS-VARIABLE: EGIT_BRANCH
58 # @DEFAULT_UNSET
59 # @DESCRIPTION:
60 # The branch name to check out. If unset, the upstream default (HEAD)
61 # will be used.
62 #
63 # It can be overriden via env using ${PN}_LIVE_BRANCH variable.
64
65 # @ECLASS-VARIABLE: EGIT_COMMIT
66 # @DEFAULT_UNSET
67 # @DESCRIPTION:
68 # The tag name or commit identifier to check out. If unset, newest
69 # commit from the branch will be used. If set, EGIT_BRANCH will
70 # be ignored.
71 #
72 # It can be overriden via env using ${PN}_LIVE_COMMIT variable.
73
74 # @ECLASS-VARIABLE: EGIT_CHECKOUT_DIR
75 # @DESCRIPTION:
76 # The directory to check the git sources out to.
77 #
78 # EGIT_CHECKOUT_DIR=${WORKDIR}/${P}
79
80 # @ECLASS-VARIABLE: EGIT_NONSHALLOW
81 # @DEFAULT_UNSET
82 # @DESCRIPTION:
83 # Disable performing shallow fetches/clones. Shallow clones have
84 # a fair number of limitations. Therefore, if you'd like the eclass to
85 # perform complete clones instead, set this to a non-null value.
86 #
87 # This variable is to be set in make.conf. Ebuilds are not allowed
88 # to set it.
89
90 # @FUNCTION: _git-r3_env_setup
91 # @INTERNAL
92 # @DESCRIPTION:
93 # Set the eclass variables as necessary for operation. This can involve
94 # setting EGIT_* to defaults or ${PN}_LIVE_* variables.
95 _git-r3_env_setup() {
96 debug-print-function ${FUNCNAME} "$@"
97
98 local esc_pn livevar
99 esc_pn=${PN//[-+]/_}
100
101 livevar=${esc_pn}_LIVE_REPO
102 EGIT_REPO_URI=${!livevar:-${EGIT_REPO_URI}}
103 [[ ${!livevar} ]] \
104 && ewarn "Using ${livevar}, no support will be provided"
105
106 livevar=${esc_pn}_LIVE_BRANCH
107 EGIT_BRANCH=${!livevar:-${EGIT_BRANCH}}
108 [[ ${!livevar} ]] \
109 && ewarn "Using ${livevar}, no support will be provided"
110
111 livevar=${esc_pn}_LIVE_COMMIT
112 EGIT_COMMIT=${!livevar:-${EGIT_COMMIT}}
113 [[ ${!livevar} ]] \
114 && ewarn "Using ${livevar}, no support will be provided"
115
116 # Migration helpers. Remove them when git-2 is removed.
117
118 if [[ ${EGIT_SOURCEDIR} ]]; then
119 eerror "EGIT_SOURCEDIR has been replaced by EGIT_CHECKOUT_DIR. While updating"
120 eerror "your ebuild, please check whether the variable is necessary at all"
121 eerror "since the default has been changed from \${S} to \${WORKDIR}/\${P}."
122 eerror "Therefore, proper setting of S may be sufficient."
123 die "EGIT_SOURCEDIR has been replaced by EGIT_CHECKOUT_DIR."
124 fi
125
126 if [[ ${EGIT_MASTER} ]]; then
127 eerror "EGIT_MASTER has been removed. Instead, the upstream default (HEAD)"
128 eerror "is used by the eclass. Please remove the assignment or use EGIT_BRANCH"
129 eerror "as necessary."
130 die "EGIT_MASTER has been removed."
131 fi
132
133 if [[ ${EGIT_HAS_SUBMODULES} ]]; then
134 eerror "EGIT_HAS_SUBMODULES has been removed. The eclass no longer needs"
135 eerror "to switch the clone type in order to support submodules and therefore"
136 eerror "submodules are detected and fetched automatically."
137 die "EGIT_HAS_SUBMODULES is no longer necessary."
138 fi
139
140 if [[ ${EGIT_PROJECT} ]]; then
141 eerror "EGIT_PROJECT has been removed. Instead, the eclass determines"
142 eerror "the local clone path using path in canonical EGIT_REPO_URI."
143 eerror "If the current algorithm causes issues for you, please report a bug."
144 die "EGIT_PROJECT is no longer necessary."
145 fi
146
147 if [[ ${EGIT_BOOTSTRAP} ]]; then
148 eerror "EGIT_BOOTSTRAP has been removed. Please create proper src_prepare()"
149 eerror "instead."
150 die "EGIT_BOOTSTRAP has been removed."
151 fi
152
153 if [[ ${EGIT_NOUNPACK} ]]; then
154 eerror "EGIT_NOUNPACK has been removed. The eclass no longer calls default"
155 eerror "unpack function. If necessary, please declare proper src_unpack()."
156 die "EGIT_NOUNPACK has been removed."
157 fi
158 }
159
160 # @FUNCTION: _git-r3_set_gitdir
161 # @USAGE: <repo-uri>
162 # @INTERNAL
163 # @DESCRIPTION:
164 # Obtain the local repository path and set it as GIT_DIR. Creates
165 # a new repository if necessary.
166 #
167 # <repo-uri> may be used to compose the path. It should therefore be
168 # a canonical URI to the repository.
169 _git-r3_set_gitdir() {
170 debug-print-function ${FUNCNAME} "$@"
171
172 local repo_name=${1#*://*/}
173
174 # strip common prefixes to make paths more likely to match
175 # e.g. git://X/Y.git vs https://X/git/Y.git
176 # (but just one of the prefixes)
177 case "${repo_name}" in
178 # cgit can proxy requests to git
179 cgit/*) repo_name=${repo_name#cgit/};;
180 # pretty common
181 git/*) repo_name=${repo_name#git/};;
182 # gentoo.org
183 gitroot/*) repo_name=${repo_name#gitroot/};;
184 # google code, sourceforge
185 p/*) repo_name=${repo_name#p/};;
186 # kernel.org
187 pub/scm/*) repo_name=${repo_name#pub/scm/};;
188 esac
189 # ensure a .git suffix, same reason
190 repo_name=${repo_name%.git}.git
191 # now replace all the slashes
192 repo_name=${repo_name//\//_}
193
194 local distdir=${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}
195 : ${EGIT3_STORE_DIR:=${distdir}/git3-src}
196
197 GIT_DIR=${EGIT3_STORE_DIR}/${repo_name}
198
199 if [[ ! -d ${EGIT3_STORE_DIR} ]]; then
200 (
201 addwrite /
202 mkdir -m0755 -p "${EGIT3_STORE_DIR}"
203 ) || die "Unable to create ${EGIT3_STORE_DIR}"
204 fi
205
206 addwrite "${EGIT3_STORE_DIR}"
207 if [[ ! -d ${GIT_DIR} ]]; then
208 mkdir "${GIT_DIR}" || die
209 git init --bare || die
210
211 # avoid auto-unshallow :)
212 touch "${GIT_DIR}"/shallow || die
213 fi
214 }
215
216 # @FUNCTION: _git-r3_set_submodules
217 # @USAGE: <file-contents>
218 # @INTERNAL
219 # @DESCRIPTION:
220 # Parse .gitmodules contents passed as <file-contents>
221 # as in "$(cat .gitmodules)"). Composes a 'submodules' array that
222 # contains in order (name, URL, path) for each submodule.
223 _git-r3_set_submodules() {
224 debug-print-function ${FUNCNAME} "$@"
225
226 local data=${1}
227
228 # ( name url path ... )
229 submodules=()
230
231 local l
232 while read l; do
233 # submodule.<path>.path=<path>
234 # submodule.<path>.url=<url>
235 [[ ${l} == submodule.*.url=* ]] || continue
236
237 l=${l#submodule.}
238 local subname=${l%%.url=*}
239
240 submodules+=(
241 "${subname}"
242 "$(echo "${data}" | git config -f /dev/fd/0 \
243 submodule."${subname}".url)"
244 "$(echo "${data}" | git config -f /dev/fd/0 \
245 submodule."${subname}".path)"
246 )
247 done < <(echo "${data}" | git config -f /dev/fd/0 -l)
248 }
249
250 # @FUNCTION: git-r3_fetch
251 # @USAGE: [<repo-uri> [<remote-ref> [<local-id>]]]
252 # @DESCRIPTION:
253 # Fetch new commits to the local clone of repository.
254 #
255 # <repo-uri> specifies the repository URIs to fetch from, as a space-
256 # -separated list. The first URI will be used as repository group
257 # identifier and therefore must be used consistently. When not
258 # specified, defaults to ${EGIT_REPO_URI}.
259 #
260 # <remote-ref> specifies the remote ref or commit id to fetch.
261 # It is preferred to use 'refs/heads/<branch-name>' for branches
262 # and 'refs/tags/<tag-name>' for tags. Other options are 'HEAD'
263 # for upstream default branch and hexadecimal commit SHA1. Defaults
264 # to the first of EGIT_COMMIT, EGIT_BRANCH or literal 'HEAD' that
265 # is set to a non-null value.
266 #
267 # <local-id> specifies the local branch identifier that will be used to
268 # locally store the fetch result. It should be unique to multiple
269 # fetches within the repository that can be performed at the same time
270 # (including parallel merges). It defaults to ${CATEGORY}/${PN}/${SLOT}.
271 # This default should be fine unless you are fetching multiple trees
272 # from the same repository in the same ebuild.
273 #
274 # The fetch operation will affect the EGIT_STORE only. It will not touch
275 # the working copy, nor export any environment variables.
276 # If the repository contains submodules, they will be fetched
277 # recursively.
278 git-r3_fetch() {
279 debug-print-function ${FUNCNAME} "$@"
280
281 local repos=( ${1:-${EGIT_REPO_URI}} )
282 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
283 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
284 local local_id=${3:-${CATEGORY}/${PN}/${SLOT}}
285 local local_ref=refs/heads/${local_id}/__main__
286
287 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
288
289 local -x GIT_DIR
290 _git-r3_set_gitdir ${repos[0]}
291
292 # try to fetch from the remote
293 local r success
294 for r in ${repos[@]}; do
295 einfo "Fetching ${remote_ref} from ${r} ..."
296
297 local is_branch lookup_ref
298 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]]
299 then
300 is_branch=1
301 lookup_ref=${remote_ref}
302 else
303 # ls-remote by commit is going to fail anyway,
304 # so we may as well pass refs/tags/ABCDEF...
305 lookup_ref=refs/tags/${remote_ref}
306 fi
307
308 # first, try ls-remote to see if ${remote_ref} is a real ref
309 # and not a commit id. if it succeeds, we can pass ${remote_ref}
310 # to 'fetch'. otherwise, we will just fetch everything
311
312 # split on whitespace
313 local ref=(
314 $(git ls-remote "${r}" "${lookup_ref}")
315 )
316
317 # now, another important thing. we may only fetch a remote
318 # branch directly to a local branch. Otherwise, we need to fetch
319 # the commit and re-create the branch on top of it.
320
321 local ref_param=()
322 if [[ ! ${ref[0]} ]]; then
323 local EGIT_NONSHALLOW=1
324 fi
325
326 if [[ ! -f ${GIT_DIR}/shallow ]]; then
327 # if it's a complete repo, fetch it as-is
328 :
329 elif [[ ${EGIT_NONSHALLOW} ]]; then
330 # if it's a shallow clone but we need complete,
331 # unshallow it
332 ref_param+=( --unshallow )
333 else
334 # otherwise, just fetch as shallow
335 ref_param+=( --depth 1 )
336 fi
337
338 if [[ ${ref[0]} ]]; then
339 if [[ ${is_branch} ]]; then
340 ref_param+=( -f "${remote_ref}:${local_id}/__main__" )
341 else
342 ref_param+=( "refs/tags/${remote_ref}" )
343 fi
344 fi
345
346 # if ${remote_ref} is branch or tag, ${ref[@]} will contain
347 # the respective commit id. otherwise, it will be an empty
348 # array, so the following won't evaluate to a parameter.
349 set -- git fetch --no-tags "${r}" "${ref_param[@]}"
350 echo "${@}" >&2
351 if "${@}"; then
352 if [[ ! ${is_branch} ]]; then
353 set -- git branch -f "${local_id}/__main__" \
354 "${ref[0]:-${remote_ref}}"
355 echo "${@}" >&2
356 if ! "${@}"; then
357 die "Creating branch for ${remote_ref} failed (wrong ref?)."
358 fi
359 fi
360
361 success=1
362 break
363 fi
364 done
365 [[ ${success} ]] || die "Unable to fetch from any of EGIT_REPO_URI"
366
367 # recursively fetch submodules
368 if git cat-file -e "${local_ref}":.gitmodules &>/dev/null; then
369 local submodules
370 _git-r3_set_submodules \
371 "$(git cat-file -p "${local_ref}":.gitmodules || die)"
372
373 while [[ ${submodules[@]} ]]; do
374 local subname=${submodules[0]}
375 local url=${submodules[1]}
376 local path=${submodules[2]}
377 local commit=$(git rev-parse "${local_ref}:${path}")
378
379 if [[ ! ${commit} ]]; then
380 die "Unable to get commit id for submodule ${subname}"
381 fi
382
383 git-r3_fetch "${url}" "${commit}" "${local_id}/${subname}"
384
385 submodules=( "${submodules[@]:3}" ) # shift
386 done
387 fi
388 }
389
390 # @FUNCTION: git-r3_checkout
391 # @USAGE: [<repo-uri> [<checkout-path> [<local-id>]]]
392 # @DESCRIPTION:
393 # Check the previously fetched tree to the working copy.
394 #
395 # <repo-uri> specifies the repository URIs, as a space-separated list.
396 # The first URI will be used as repository group identifier
397 # and therefore must be used consistently with git-r3_fetch.
398 # The remaining URIs are not used and therefore may be omitted.
399 # When not specified, defaults to ${EGIT_REPO_URI}.
400 #
401 # <checkout-path> specifies the path to place the checkout. It defaults
402 # to ${EGIT_CHECKOUT_DIR} if set, otherwise to ${WORKDIR}/${P}.
403 #
404 # <local-id> needs to specify the local identifier that was used
405 # for respective git-r3_fetch.
406 #
407 # The checkout operation will write to the working copy, and export
408 # the repository state into the environment. If the repository contains
409 # submodules, they will be checked out recursively.
410 git-r3_checkout() {
411 debug-print-function ${FUNCNAME} "$@"
412
413 local repos=( ${1:-${EGIT_REPO_URI}} )
414 local out_dir=${2:-${EGIT_CHECKOUT_DIR:-${WORKDIR}/${P}}}
415 local local_id=${3:-${CATEGORY}/${PN}/${SLOT}}
416
417 local -x GIT_DIR GIT_WORK_TREE
418 _git-r3_set_gitdir ${repos[0]}
419 GIT_WORK_TREE=${out_dir}
420 mkdir -p "${GIT_WORK_TREE}"
421
422 einfo "Checking out ${repos[0]} to ${out_dir} ..."
423
424 if ! git cat-file -e refs/heads/"${local_id}"/__main__
425 then
426 if [[ ${EVCS_OFFLINE} ]]; then
427 die "No local clone of ${repos[0]}. Unable to work with EVCS_OFFLINE."
428 else
429 die "Logic error: no local clone of ${repos[0]}. git-r3_fetch not used?"
430 fi
431 fi
432
433 set -- git checkout -f "${local_id}"/__main__ .
434 echo "${@}" >&2
435 "${@}" || die "git checkout ${local_id}/__main__ failed"
436
437 # diff against previous revision (if any)
438 local new_commit_id=$(git rev-parse --verify "${local_id}"/__main__)
439 local old_commit_id=$(
440 git rev-parse --verify "${local_id}"/__old__ 2>/dev/null
441 )
442
443 if [[ ! ${old_commit_id} ]]; then
444 echo "GIT NEW branch -->"
445 echo " repository: ${repos[0]}"
446 echo " at the commit: ${new_commit_id}"
447 else
448 echo "GIT update -->"
449 echo " repository: ${repos[0]}"
450 # write out message based on the revisions
451 if [[ "${old_commit_id}" != "${new_commit_id}" ]]; then
452 echo " updating from commit: ${old_commit_id}"
453 echo " to commit: ${new_commit_id}"
454
455 git --no-pager diff --stat \
456 ${old_commit_id}..${new_commit_id}
457 else
458 echo " at the commit: ${new_commit_id}"
459 fi
460 fi
461 git branch -f "${local_id}"/{__old__,__main__} || die
462
463 # recursively checkout submodules
464 if [[ -f ${GIT_WORK_TREE}/.gitmodules ]]; then
465 local submodules
466 _git-r3_set_submodules \
467 "$(<"${GIT_WORK_TREE}"/.gitmodules)"
468
469 while [[ ${submodules[@]} ]]; do
470 local subname=${submodules[0]}
471 local url=${submodules[1]}
472 local path=${submodules[2]}
473
474 git-r3_checkout "${url}" "${GIT_WORK_TREE}/${path}" \
475 "${local_id}/${subname}"
476
477 submodules=( "${submodules[@]:3}" ) # shift
478 done
479 fi
480
481 # keep this *after* submodules
482 export EGIT_DIR=${GIT_DIR}
483 export EGIT_VERSION=${new_commit_id}
484 }
485
486 # @FUNCTION: git-r3_peek_remote_ref
487 # @USAGE: [<repo-uri> [<remote-ref>]]
488 # @DESCRIPTION:
489 # Peek the reference in the remote repository and print the matching
490 # (newest) commit SHA1.
491 #
492 # <repo-uri> specifies the repository URIs to fetch from, as a space-
493 # -separated list. When not specified, defaults to ${EGIT_REPO_URI}.
494 #
495 # <remote-ref> specifies the remote ref to peek. It is preferred to use
496 # 'refs/heads/<branch-name>' for branches and 'refs/tags/<tag-name>'
497 # for tags. Alternatively, 'HEAD' may be used for upstream default
498 # branch. Defaults to the first of EGIT_COMMIT, EGIT_BRANCH or literal
499 # 'HEAD' that is set to a non-null value.
500 #
501 # The operation will be done purely on the remote, without using local
502 # storage. If commit SHA1 is provided as <remote-ref>, the function will
503 # fail due to limitations of git protocol.
504 #
505 # On success, the function returns 0 and writes hexadecimal commit SHA1
506 # to stdout. On failure, the function returns 1.
507 git-r3_peek_remote_ref() {
508 debug-print-function ${FUNCNAME} "$@"
509
510 local repos=( ${1:-${EGIT_REPO_URI}} )
511 local branch=${EGIT_BRANCH:+refs/heads/${EGIT_BRANCH}}
512 local remote_ref=${2:-${EGIT_COMMIT:-${branch:-HEAD}}}
513
514 [[ ${repos[@]} ]] || die "No URI provided and EGIT_REPO_URI unset"
515
516 local r success
517 for r in ${repos[@]}; do
518 einfo "Peeking ${remote_ref} on ${r} ..." >&2
519
520 local is_branch lookup_ref
521 if [[ ${remote_ref} == refs/heads/* || ${remote_ref} == HEAD ]]
522 then
523 is_branch=1
524 lookup_ref=${remote_ref}
525 else
526 # ls-remote by commit is going to fail anyway,
527 # so we may as well pass refs/tags/ABCDEF...
528 lookup_ref=refs/tags/${remote_ref}
529 fi
530
531 # split on whitespace
532 local ref=(
533 $(git ls-remote "${r}" "${lookup_ref}")
534 )
535
536 if [[ ${ref[0]} ]]; then
537 echo "${ref[0]}"
538 return 0
539 fi
540 done
541
542 return 1
543 }
544
545 git-r3_src_fetch() {
546 debug-print-function ${FUNCNAME} "$@"
547
548 [[ ${EVCS_OFFLINE} ]] && return
549
550 if [[ ! ${EGIT3_STORE_DIR} && ${EGIT_STORE_DIR} ]]; then
551 ewarn "You have set EGIT_STORE_DIR but not EGIT3_STORE_DIR. Please consider"
552 ewarn "setting EGIT3_STORE_DIR for git-r3.eclass. It is recommended to use"
553 ewarn "a different directory than EGIT_STORE_DIR to ease removing old clones"
554 ewarn "when git-2 eclass becomes deprecated."
555 fi
556
557 _git-r3_env_setup
558 git-r3_fetch
559 }
560
561 git-r3_src_unpack() {
562 debug-print-function ${FUNCNAME} "$@"
563
564 _git-r3_env_setup
565 git-r3_src_fetch
566 git-r3_checkout
567 }
568
569 # https://bugs.gentoo.org/show_bug.cgi?id=482666
570 git-r3_pkg_outofdate() {
571 debug-print-function ${FUNCNAME} "$@"
572
573 local new_commit_id=$(git-r3_peek_remote_ref)
574 ewarn "old: ${EGIT_VERSION}"
575 ewarn "new: ${new_commit_id}"
576 [[ ${new_commit_id} && ${old_commit_id} ]] || return 2
577
578 [[ ${EGIT_VERSION} != ${new_commit_id} ]]
579 }
580
581 _GIT_R3=1
582 fi

  ViewVC Help
Powered by ViewVC 1.1.20