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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.37 - (hide annotations) (download)
Fri Jan 22 09:32:57 2010 UTC (4 years, 6 months ago) by scarabeus
Branch: MAIN
Changes since 1.36: +21 -12 lines
Update git eclass to work hopefully with git-submodules yet again. Drop usage of eqawarn.

1 scarabeus 1.17 # Copyright 1999-2009 Gentoo Foundation
2 ferdy 1.1 # Distributed under the terms of the GNU General Public License v2
3 scarabeus 1.37 # $Header: /var/cvsroot/gentoo-x86/eclass/git.eclass,v 1.36 2010/01/13 22:14:59 scarabeus Exp $
4 ferdy 1.1
5 scarabeus 1.17 # @ECLASS: git.eclass
6     # @MAINTAINER:
7     # Tomas Chvatal <scarabeus@gentoo.org>
8     # Donnie Berkholz <dberkholz@gentoo.org>
9 scarabeus 1.20 # @BLURB: This eclass provides functions for fetch and unpack git repositories
10 scarabeus 1.17 # @DESCRIPTION:
11     # The eclass is based on subversion eclass.
12     # If you use this eclass, the ${S} is ${WORKDIR}/${P}.
13     # It is necessary to define the EGIT_REPO_URI variable at least.
14     # @THANKS TO:
15     # Fernando J. Pereda <ferdy@gentoo.org>
16 ferdy 1.1
17 scarabeus 1.25 inherit eutils
18 ferdy 1.1
19     EGIT="git.eclass"
20    
21 scarabeus 1.17 EXPORTED_FUNCTIONS="src_unpack"
22     case "${EAPI:-0}" in
23 scarabeus 1.19 2) EXPORTED_FUNCTIONS="${EXPORTED_FUNCTIONS} src_prepare" ;;
24 scarabeus 1.17 0|1) ;;
25     *) die "Unknown EAPI, Bug eclass maintainers." ;;
26     esac
27     EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS}
28 ferdy 1.1
29 scarabeus 1.17 # define some nice defaults but only if nothing is set already
30     : ${HOMEPAGE:=http://git-scm.com/}
31 ferdy 1.1
32 scarabeus 1.17 # We DEPEND on at least a bit recent git version
33     DEPEND=">=dev-util/git-1.6"
34 ferdy 1.1
35 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_QUIET
36     # @DESCRIPTION:
37     # Enables user specified verbosity for the eclass elog informations.
38     # The user just needs to add EGIT_QUIET="ON" to the /etc/make.conf.
39     : ${EGIT_QUIET:="OFF"}
40 ferdy 1.1
41 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_STORE_DIR
42     # @DESCRIPTION:
43     # Storage directory for git sources.
44 scarabeus 1.27 # Can be redefined.
45     [[ -z ${EGIT_STORE_DIR} ]] && EGIT_STORE_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/git-src"
46 ferdy 1.1
47 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_FETCH_CMD
48     # @DESCRIPTION:
49     # Command for cloning the repository.
50 scarabeus 1.32 : ${EGIT_FETCH_CMD:="git clone"}
51 ferdy 1.1
52 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_UPDATE_CMD
53     # @DESCRIPTION:
54     # Git fetch command.
55 scarabeus 1.35 EGIT_UPDATE_CMD="git pull -f -u"
56 ferdy 1.1
57 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_DIFFSTAT_CMD
58     # @DESCRIPTION:
59     # Git command for diffstat.
60 robbat2 1.18 EGIT_DIFFSTAT_CMD="git --no-pager diff --stat"
61 ferdy 1.1
62 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_OPTIONS
63     # @DESCRIPTION:
64     # This variable value is passed to clone and fetch.
65 ferdy 1.1 : ${EGIT_OPTIONS:=}
66    
67 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_REPO_URI
68     # @DESCRIPTION:
69     # URI for the repository
70 ferdy 1.1 # e.g. http://foo, git://bar
71 scarabeus 1.17 # Supported protocols:
72 ferdy 1.1 # http://
73     # https://
74     # git://
75     # git+ssh://
76     # rsync://
77     # ssh://
78 scarabeus 1.29 eval X="\$${PN//[-+]/_}_LIVE_REPO"
79 scarabeus 1.28 if [[ ${X} = "" ]]; then
80     EGIT_REPO_URI=${EGIT_REPO_URI:=}
81     else
82     EGIT_REPO_URI="${X}"
83     fi
84 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_PROJECT
85     # @DESCRIPTION:
86     # Project name of your ebuild.
87     # Git eclass will check out the git repository like:
88     # ${EGIT_STORE_DIR}/${EGIT_PROJECT}/${EGIT_REPO_URI##*/}
89 ferdy 1.1 # so if you define EGIT_REPO_URI as http://git.collab.net/repo/git or
90     # http://git.collab.net/repo/git. and PN is subversion-git.
91     # it will check out like:
92 scarabeus 1.17 # ${EGIT_STORE_DIR}/subversion
93 ferdy 1.1 : ${EGIT_PROJECT:=${PN/-git}}
94    
95 scarabeus 1.31 # @ECLASS-VARIABLE: EGIT_BOOTSTRAP
96 scarabeus 1.17 # @DESCRIPTION:
97     # bootstrap script or command like autogen.sh or etc...
98 ferdy 1.1 : ${EGIT_BOOTSTRAP:=}
99    
100 robbat2 1.9 # @ECLASS-VARIABLE: EGIT_OFFLINE
101     # @DESCRIPTION:
102     # Set this variable to a non-empty value to disable the automatic updating of
103 robbat2 1.10 # an GIT source tree. This is intended to be set outside the git source
104 robbat2 1.9 # tree by users.
105     EGIT_OFFLINE="${EGIT_OFFLINE:-${ESCM_OFFLINE}}"
106 ferdy 1.1
107 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_PATCHES
108     # @DESCRIPTION:
109     # Similar to PATCHES array from base.eclass
110     # Only difference is that this patches are applied before bootstrap.
111     # Please take note that this variable should be bash array.
112 ferdy 1.1
113 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_BRANCH
114     # @DESCRIPTION:
115 ferdy 1.1 # git eclass can fetch any branch in git_fetch().
116 scarabeus 1.29 eval X="\$${PN//[-+]/_}_LIVE_BRANCH"
117 scarabeus 1.28 if [[ ${X} = "" ]]; then
118     EGIT_BRANCH=${EGIT_BRANCH:=master}
119     else
120     EGIT_BRANCH="${X}"
121     fi
122 ferdy 1.1
123 scarabeus 1.32 # @ECLASS-VARIABLE: EGIT_COMMIT
124 scarabeus 1.17 # @DESCRIPTION:
125 scarabeus 1.32 # git eclass can checkout any commit.
126     eval X="\$${PN//[-+]/_}_LIVE_COMMIT"
127 scarabeus 1.28 if [[ ${X} = "" ]]; then
128 scarabeus 1.32 : ${EGIT_COMMIT:=${EGIT_BRANCH}}
129 scarabeus 1.28 else
130 scarabeus 1.32 EGIT_COMMIT="${X}"
131 scarabeus 1.28 fi
132 ferdy 1.1
133 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_REPACK
134     # @DESCRIPTION:
135 ferdy 1.1 # git eclass will repack objects to save disk space. However this can take a
136 scarabeus 1.17 # long time with VERY big repositories.
137 ferdy 1.1 : ${EGIT_REPACK:=false}
138    
139 scarabeus 1.17 # @ECLASS-VARIABLE: EGIT_PRUNE
140     # @DESCRIPTION:
141 scarabeus 1.32 # git eclass can prune the local clone. This is useful if upstream rewinds and
142 scarabeus 1.17 # rebases branches too often.
143 ferdy 1.1 : ${EGIT_PRUNE:=false}
144    
145 scarabeus 1.32 # @FUNCTION: git_submodules
146     # @DESCRIPTION:
147     # Internal function wrapping the submodule initialisation and update
148 scarabeus 1.37 git_submodules() {
149 scarabeus 1.32 debug-print "git submodule init"
150     git submodule init
151     debug-print "git submodule update"
152     git submodule update
153     }
154    
155 scarabeus 1.36 # @FUNCTION: git_branch
156     # @DESCRIPTION:
157     # Internal function that changes branch for the repo based on EGIT_TREE and
158     # EGIT_BRANCH variables.
159     git_branch() {
160     local branchname=branch-${EGIT_BRANCH} src=origin/${EGIT_BRANCH}
161     if [[ ${EGIT_COMMIT} != ${EGIT_BRANCH} ]]; then
162     branchname=tree-${EGIT_COMMIT}
163     src=${EGIT_COMMIT}
164     fi
165     debug-print "git checkout -b ${branchname} ${src}"
166     git checkout -b ${branchname} ${src} &> /dev/null
167    
168     unset branchname src
169     }
170    
171 scarabeus 1.17 # @FUNCTION: git_fetch
172     # @DESCRIPTION:
173     # Gets repository from EGIT_REPO_URI and store it in specified EGIT_STORE_DIR
174     git_fetch() {
175     debug-print-function ${FUNCNAME} "$@"
176 ferdy 1.1
177 scarabeus 1.32 local GIT_DIR EGIT_CLONE_DIR oldsha1 cursha1
178 ferdy 1.1
179 scarabeus 1.17 # choose if user wants elog or just einfo.
180     if [[ ${EGIT_QUIET} != OFF ]]; then
181     elogcmd="einfo"
182     else
183     elogcmd="elog"
184     fi
185 ferdy 1.1
186 scarabeus 1.17 # If we have same branch and the tree we can do --depth 1 clone
187     # which outputs into really smaller data transfers.
188 scarabeus 1.21 # Sadly we can do shallow copy for now because quite a few packages need .git
189 scarabeus 1.17 # folder.
190 scarabeus 1.32 #[[ ${EGIT_COMMIT} = ${EGIT_BRANCH} ]] && \
191 scarabeus 1.17 # EGIT_FETCH_CMD="${EGIT_FETCH_CMD} --depth 1"
192 scarabeus 1.32 if [[ ! -z ${EGIT_TREE} ]] ; then
193     EGIT_COMMIT=${EGIT_TREE}
194 scarabeus 1.37 ewarn "QA: Usage of deprecated EGIT_TREE variable detected."
195     ewarn "QA: Use EGIT_COMMIT variable instead."
196 scarabeus 1.32 fi
197 ferdy 1.1
198     # EGIT_REPO_URI is empty.
199     [[ -z ${EGIT_REPO_URI} ]] && die "${EGIT}: EGIT_REPO_URI is empty."
200    
201 ferdy 1.4 # check for the protocol or pull from a local repo.
202     if [[ -z ${EGIT_REPO_URI%%:*} ]] ; then
203     case ${EGIT_REPO_URI%%:*} in
204 scarabeus 1.17 git*|http|https|rsync|ssh) ;;
205     *) die "${EGIT}: protocol for fetch from "${EGIT_REPO_URI%:*}" is not yet implemented in eclass." ;;
206 ferdy 1.4 esac
207     fi
208 ferdy 1.1
209 scarabeus 1.17 # initial clone, we have to create master git storage directory and play
210     # nicely with sandbox
211 ferdy 1.1 if [[ ! -d ${EGIT_STORE_DIR} ]] ; then
212     debug-print "${FUNCNAME}: initial clone. creating git directory"
213     addwrite /
214     mkdir -p "${EGIT_STORE_DIR}" \
215     || die "${EGIT}: can't mkdir ${EGIT_STORE_DIR}."
216     export SANDBOX_WRITE="${SANDBOX_WRITE%%:/}"
217     fi
218    
219     cd -P "${EGIT_STORE_DIR}" || die "${EGIT}: can't chdir to ${EGIT_STORE_DIR}"
220     EGIT_STORE_DIR=${PWD}
221    
222 scarabeus 1.17 # allow writing into EGIT_STORE_DIR
223 ferdy 1.1 addwrite "${EGIT_STORE_DIR}"
224    
225     [[ -z ${EGIT_REPO_URI##*/} ]] && EGIT_REPO_URI="${EGIT_REPO_URI%/}"
226     EGIT_CLONE_DIR="${EGIT_PROJECT}"
227    
228     debug-print "${FUNCNAME}: EGIT_OPTIONS = \"${EGIT_OPTIONS}\""
229    
230 scarabeus 1.32 GIT_DIR="${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}"
231 scarabeus 1.21 # we also have to remove all shallow copied repositories
232     # and fetch them again
233 scarabeus 1.32 if [[ -e "${GIT_DIR}/shallow" ]]; then
234     rm -rf "${GIT_DIR}"
235 scarabeus 1.21 einfo "The ${EGIT_CLONE_DIR} was shallow copy. Refetching."
236     fi
237 scarabeus 1.32 # repack from bare copy to normal one
238     if [[ -d ${GIT_DIR} && ! -d "${GIT_DIR}/.git/" ]]; then
239     rm -rf "${GIT_DIR}"
240     einfo "The ${EGIT_CLONE_DIR} was bare copy. Refetching."
241     fi
242 scarabeus 1.21
243 scarabeus 1.32 if [[ ! -d ${GIT_DIR} ]] ; then
244 ferdy 1.1 # first clone
245 scarabeus 1.17 ${elogcmd} "GIT NEW clone -->"
246     ${elogcmd} " repository: ${EGIT_REPO_URI}"
247 ferdy 1.1
248 scarabeus 1.32 debug-print "${EGIT_FETCH_CMD} ${EGIT_OPTIONS} \"${EGIT_REPO_URI}\" ${GIT_DIR}"
249     ${EGIT_FETCH_CMD} ${EGIT_OPTIONS} "${EGIT_REPO_URI}" ${GIT_DIR} \
250 ferdy 1.1 || die "${EGIT}: can't fetch from ${EGIT_REPO_URI}."
251 scarabeus 1.32
252     pushd "${GIT_DIR}" &> /dev/null
253     cursha1=$(git rev-parse origin/${EGIT_BRANCH})
254     ${elogcmd} " at the commit: ${cursha1}"
255 ferdy 1.1
256 scarabeus 1.37 git_submodules
257 scarabeus 1.32 popd &> /dev/null
258 robbat2 1.9 elif [[ -n ${EGIT_OFFLINE} ]] ; then
259 scarabeus 1.32 pushd "${GIT_DIR}" &> /dev/null
260     cursha1=$(git rev-parse origin/${EGIT_BRANCH})
261 scarabeus 1.17 ${elogcmd} "GIT offline update -->"
262     ${elogcmd} " repository: ${EGIT_REPO_URI}"
263 scarabeus 1.26 ${elogcmd} " at the commit: ${cursha1}"
264 scarabeus 1.32 popd &> /dev/null
265 ferdy 1.1 else
266 scarabeus 1.32 pushd "${GIT_DIR}" &> /dev/null
267 ferdy 1.7 # Git urls might change, so unconditionally set it here
268     git config remote.origin.url "${EGIT_REPO_URI}"
269    
270 ferdy 1.1 # fetch updates
271 scarabeus 1.17 ${elogcmd} "GIT update -->"
272     ${elogcmd} " repository: ${EGIT_REPO_URI}"
273 scarabeus 1.32
274     oldsha1=$(git rev-parse origin/${EGIT_BRANCH})
275 ferdy 1.1
276 scarabeus 1.32 debug-print "${EGIT_UPDATE_CMD} ${EGIT_OPTIONS}"
277 scarabeus 1.37 # fix branching
278     git checkout master
279     for x in $(git branch |grep -v "* master" |tr '\n' ' '); do
280     git branch -D ${x}
281     done
282 scarabeus 1.32 ${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} \
283 ferdy 1.1 || die "${EGIT}: can't update from ${EGIT_REPO_URI}."
284    
285 scarabeus 1.37 git_submodules
286 scarabeus 1.32 cursha1=$(git rev-parse origin/${EGIT_BRANCH})
287 scarabeus 1.17
288     # write out message based on the revisions
289     if [[ ${oldsha1} != ${cursha1} ]]; then
290     ${elogcmd} " updating from commit: ${oldsha1}"
291     ${elogcmd} " to commit: ${cursha1}"
292     else
293     ${elogcmd} " at the commit: ${cursha1}"
294 scarabeus 1.28 # @ECLASS_VARIABLE: LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED
295     # @DESCRIPTION:
296     # If this variable is set to TRUE in make.conf or somewhere in
297     # enviroment the package will fail if there is no update, thus in
298     # combination with --keep-going it would lead in not-updating
299     # pakcages that are up-to-date.
300     # TODO: this can lead to issues if more projects/packages use same repo
301     [[ ${LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED} = true ]] && \
302     debug-print "${FUNCNAME}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping." && \
303     die "${EGIT}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping."
304 scarabeus 1.17 fi
305 scarabeus 1.32 ${EGIT_DIFFSTAT_CMD} ${oldsha1}..origin/${EGIT_BRANCH}
306     popd &> /dev/null
307 ferdy 1.1 fi
308 scarabeus 1.32
309     pushd "${GIT_DIR}" &> /dev/null
310 ferdy 1.6 if ${EGIT_REPACK} || ${EGIT_PRUNE} ; then
311     ebegin "Garbage collecting the repository"
312     git gc $(${EGIT_PRUNE} && echo '--prune')
313 ferdy 1.1 eend $?
314     fi
315 scarabeus 1.32 popd &> /dev/null
316 maekke 1.30
317 scarabeus 1.26 # export the git version
318     export EGIT_VERSION="${cursha1}"
319 ferdy 1.1
320 scarabeus 1.37 # log the repo state
321 scarabeus 1.32 [[ ${EGIT_COMMIT} != ${EGIT_BRANCH} ]] && elog " commit: ${EGIT_COMMIT}"
322 scarabeus 1.17 ${elogcmd} " branch: ${EGIT_BRANCH}"
323 scarabeus 1.34 ${elogcmd} " storage directory: \"${GIT_DIR}\""
324    
325 scarabeus 1.37 pushd "${GIT_DIR}" &> /dev/null
326     debug-print "rsync -rlpgo . \"${S}\""
327     time rsync -rlpgo . "${S}"
328     popd &> /dev/null
329    
330     pushd "${S}" &> /dev/null
331     git_branch
332     # submodules always reqire net (thanks to branches changing)
333     [[ -n ${EGIT_OFFLINE} ]] || git_submodules
334 scarabeus 1.34 popd &> /dev/null
335 vapier 1.5
336     echo ">>> Unpacked to ${S}"
337 ferdy 1.1 }
338    
339 scarabeus 1.17 # @FUNCTION: git_bootstrap
340     # @DESCRIPTION:
341     # Runs bootstrap command if EGIT_BOOTSTRAP variable contains some value
342     # Remember that what ever gets to the EGIT_BOOTSTRAP variable gets evaled by bash.
343 ferdy 1.1 git_bootstrap() {
344 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
345 ferdy 1.1
346 scarabeus 1.17 if [[ -n ${EGIT_BOOTSTRAP} ]] ; then
347     pushd "${S}" > /dev/null
348     einfo "Starting bootstrap"
349 ferdy 1.1
350 scarabeus 1.17 if [[ -f ${EGIT_BOOTSTRAP} ]]; then
351     # we have file in the repo which we should execute
352     debug-print "$FUNCNAME: bootstraping with file \"${EGIT_BOOTSTRAP}\""
353    
354     if [[ -x ${EGIT_BOOTSTRAP} ]]; then
355     eval "./${EGIT_BOOTSTRAP}" \
356     || die "${EGIT}: bootstrap script failed"
357 ferdy 1.1 else
358 scarabeus 1.17 eerror "\"${EGIT_BOOTSTRAP}\" is not executable."
359     eerror "Report upstream, or bug ebuild maintainer to remove bootstrap command."
360     die "${EGIT}: \"${EGIT_BOOTSTRAP}\" is not executable."
361 ferdy 1.1 fi
362 scarabeus 1.17 else
363     # we execute some system command
364     debug-print "$FUNCNAME: bootstraping with commands \"${EGIT_BOOTSTRAP}\""
365 ferdy 1.1
366 scarabeus 1.17 eval "${EGIT_BOOTSTRAP}" \
367     || die "${EGIT}: bootstrap commands failed."
368 ferdy 1.1
369     fi
370 scarabeus 1.17
371     einfo "Bootstrap finished"
372     popd > /dev/null
373 ferdy 1.1 fi
374 scarabeus 1.17 }
375 ferdy 1.1
376 scarabeus 1.17 # @FUNCTION: git_apply_patches
377     # @DESCRIPTION:
378     # Apply patches from EGIT_PATCHES bash array.
379     # Preffered is using the variable as bash array but for now it allows to write
380     # it also as normal space separated string list. (This part of code should be
381     # removed when all ebuilds get converted on bash array).
382     git_apply_patches() {
383     debug-print-function ${FUNCNAME} "$@"
384    
385     pushd "${S}" > /dev/null
386     if [[ ${#EGIT_PATCHES[@]} -gt 1 ]] ; then
387     for i in "${EGIT_PATCHES[@]}"; do
388     debug-print "$FUNCNAME: git_autopatch: patching from ${i}"
389     epatch "${i}"
390     done
391     elif [[ ${EGIT_PATCHES} != "" ]]; then
392     # no need for loop if space separated string is passed.
393     debug-print "$FUNCNAME: git_autopatch: patching from ${EGIT_PATCHES}"
394     epatch "${EGIT_PATCHES}"
395     fi
396    
397     popd > /dev/null
398 ferdy 1.1 }
399    
400 scarabeus 1.17 # @FUNCTION: git_src_unpack
401     # @DESCRIPTION:
402     # src_upack function, calls src_prepare one if EAPI!=2.
403     git_src_unpack() {
404     debug-print-function ${FUNCNAME} "$@"
405 ferdy 1.1
406 scarabeus 1.17 git_fetch || die "${EGIT}: unknown problem in git_fetch()."
407 ferdy 1.1
408 scarabeus 1.17 has src_prepare ${EXPORTED_FUNCTIONS} || git_src_prepare
409     }
410 ferdy 1.1
411 scarabeus 1.17 # @FUNCTION: git_src_prepare
412     # @DESCRIPTION:
413     # src_prepare function for git stuff. Patches, bootstrap...
414     git_src_prepare() {
415     debug-print-function ${FUNCNAME} "$@"
416 maekke 1.30
417 scarabeus 1.17 git_apply_patches
418     git_bootstrap
419 ferdy 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20