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

Contents of /eclass/git.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.35 - (hide annotations) (download)
Wed Jan 13 20:04:19 2010 UTC (4 years, 10 months ago) by scarabeus
Branch: MAIN
Changes since 1.34: +4 -7 lines
Revert back to safe values so it does not break stable.

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.34 # $Header: /var/cvsroot/gentoo-x86/eclass/git.eclass,v 1.33 2009/12/29 17:18:16 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     git_sumbodules() {
149     debug-print "git submodule init"
150     git submodule init
151     debug-print "git submodule update"
152     git submodule update
153     }
154    
155 scarabeus 1.17 # @FUNCTION: git_fetch
156     # @DESCRIPTION:
157     # Gets repository from EGIT_REPO_URI and store it in specified EGIT_STORE_DIR
158     git_fetch() {
159     debug-print-function ${FUNCNAME} "$@"
160 ferdy 1.1
161 scarabeus 1.32 local GIT_DIR EGIT_CLONE_DIR oldsha1 cursha1
162 ferdy 1.1
163 scarabeus 1.17 # choose if user wants elog or just einfo.
164     if [[ ${EGIT_QUIET} != OFF ]]; then
165     elogcmd="einfo"
166     else
167     elogcmd="elog"
168     fi
169 ferdy 1.1
170 scarabeus 1.17 # If we have same branch and the tree we can do --depth 1 clone
171     # which outputs into really smaller data transfers.
172 scarabeus 1.21 # Sadly we can do shallow copy for now because quite a few packages need .git
173 scarabeus 1.17 # folder.
174 scarabeus 1.32 #[[ ${EGIT_COMMIT} = ${EGIT_BRANCH} ]] && \
175 scarabeus 1.17 # EGIT_FETCH_CMD="${EGIT_FETCH_CMD} --depth 1"
176 scarabeus 1.32 if [[ ! -z ${EGIT_TREE} ]] ; then
177     EGIT_COMMIT=${EGIT_TREE}
178     eqawarn "Usage of deprecated EGIT_TREE variable detected."
179     eqawarn "Use EGIT_COMMIT variable instead."
180     fi
181 ferdy 1.1
182     # EGIT_REPO_URI is empty.
183     [[ -z ${EGIT_REPO_URI} ]] && die "${EGIT}: EGIT_REPO_URI is empty."
184    
185 ferdy 1.4 # check for the protocol or pull from a local repo.
186     if [[ -z ${EGIT_REPO_URI%%:*} ]] ; then
187     case ${EGIT_REPO_URI%%:*} in
188 scarabeus 1.17 git*|http|https|rsync|ssh) ;;
189     *) die "${EGIT}: protocol for fetch from "${EGIT_REPO_URI%:*}" is not yet implemented in eclass." ;;
190 ferdy 1.4 esac
191     fi
192 ferdy 1.1
193 scarabeus 1.17 # initial clone, we have to create master git storage directory and play
194     # nicely with sandbox
195 ferdy 1.1 if [[ ! -d ${EGIT_STORE_DIR} ]] ; then
196     debug-print "${FUNCNAME}: initial clone. creating git directory"
197     addwrite /
198     mkdir -p "${EGIT_STORE_DIR}" \
199     || die "${EGIT}: can't mkdir ${EGIT_STORE_DIR}."
200     export SANDBOX_WRITE="${SANDBOX_WRITE%%:/}"
201     fi
202    
203     cd -P "${EGIT_STORE_DIR}" || die "${EGIT}: can't chdir to ${EGIT_STORE_DIR}"
204     EGIT_STORE_DIR=${PWD}
205    
206 scarabeus 1.17 # allow writing into EGIT_STORE_DIR
207 ferdy 1.1 addwrite "${EGIT_STORE_DIR}"
208    
209     [[ -z ${EGIT_REPO_URI##*/} ]] && EGIT_REPO_URI="${EGIT_REPO_URI%/}"
210     EGIT_CLONE_DIR="${EGIT_PROJECT}"
211    
212     debug-print "${FUNCNAME}: EGIT_OPTIONS = \"${EGIT_OPTIONS}\""
213    
214 scarabeus 1.32 GIT_DIR="${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}"
215     pushd ${EGIT_STORE_DIR} &> /dev/null
216 scarabeus 1.21 # we also have to remove all shallow copied repositories
217     # and fetch them again
218 scarabeus 1.32 if [[ -e "${GIT_DIR}/shallow" ]]; then
219     rm -rf "${GIT_DIR}"
220 scarabeus 1.21 einfo "The ${EGIT_CLONE_DIR} was shallow copy. Refetching."
221     fi
222 scarabeus 1.32 # repack from bare copy to normal one
223     if [[ -d ${GIT_DIR} && ! -d "${GIT_DIR}/.git/" ]]; then
224     rm -rf "${GIT_DIR}"
225     einfo "The ${EGIT_CLONE_DIR} was bare copy. Refetching."
226     fi
227 scarabeus 1.21
228 scarabeus 1.32 if [[ ! -d ${GIT_DIR} ]] ; then
229 ferdy 1.1 # first clone
230 scarabeus 1.17 ${elogcmd} "GIT NEW clone -->"
231     ${elogcmd} " repository: ${EGIT_REPO_URI}"
232 ferdy 1.1
233 scarabeus 1.32 debug-print "${EGIT_FETCH_CMD} ${EGIT_OPTIONS} \"${EGIT_REPO_URI}\" ${GIT_DIR}"
234     ${EGIT_FETCH_CMD} ${EGIT_OPTIONS} "${EGIT_REPO_URI}" ${GIT_DIR} \
235 ferdy 1.1 || die "${EGIT}: can't fetch from ${EGIT_REPO_URI}."
236 scarabeus 1.32
237     pushd "${GIT_DIR}" &> /dev/null
238     cursha1=$(git rev-parse origin/${EGIT_BRANCH})
239     ${elogcmd} " at the commit: ${cursha1}"
240 ferdy 1.1
241 scarabeus 1.32 git_sumbodules
242     popd &> /dev/null
243 robbat2 1.9 elif [[ -n ${EGIT_OFFLINE} ]] ; then
244 scarabeus 1.32 pushd "${GIT_DIR}" &> /dev/null
245     cursha1=$(git rev-parse origin/${EGIT_BRANCH})
246 scarabeus 1.17 ${elogcmd} "GIT offline update -->"
247     ${elogcmd} " repository: ${EGIT_REPO_URI}"
248 scarabeus 1.26 ${elogcmd} " at the commit: ${cursha1}"
249 scarabeus 1.32 popd &> /dev/null
250 ferdy 1.1 else
251 scarabeus 1.32 pushd "${GIT_DIR}" &> /dev/null
252 ferdy 1.7 # Git urls might change, so unconditionally set it here
253     git config remote.origin.url "${EGIT_REPO_URI}"
254    
255 ferdy 1.1 # fetch updates
256 scarabeus 1.17 ${elogcmd} "GIT update -->"
257     ${elogcmd} " repository: ${EGIT_REPO_URI}"
258 scarabeus 1.32
259     oldsha1=$(git rev-parse origin/${EGIT_BRANCH})
260 ferdy 1.1
261 scarabeus 1.32 debug-print "${EGIT_UPDATE_CMD} ${EGIT_OPTIONS}"
262     ${EGIT_UPDATE_CMD} ${EGIT_OPTIONS} \
263 ferdy 1.1 || die "${EGIT}: can't update from ${EGIT_REPO_URI}."
264    
265 scarabeus 1.32 git_sumbodules
266     cursha1=$(git rev-parse origin/${EGIT_BRANCH})
267 scarabeus 1.17
268     # write out message based on the revisions
269     if [[ ${oldsha1} != ${cursha1} ]]; then
270     ${elogcmd} " updating from commit: ${oldsha1}"
271     ${elogcmd} " to commit: ${cursha1}"
272     else
273     ${elogcmd} " at the commit: ${cursha1}"
274 scarabeus 1.28 # @ECLASS_VARIABLE: LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED
275     # @DESCRIPTION:
276     # If this variable is set to TRUE in make.conf or somewhere in
277     # enviroment the package will fail if there is no update, thus in
278     # combination with --keep-going it would lead in not-updating
279     # pakcages that are up-to-date.
280     # TODO: this can lead to issues if more projects/packages use same repo
281     [[ ${LIVE_FAIL_FETCH_IF_REPO_NOT_UPDATED} = true ]] && \
282     debug-print "${FUNCNAME}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping." && \
283     die "${EGIT}: Repository \"${EGIT_REPO_URI}\" is up-to-date. Skipping."
284 scarabeus 1.17 fi
285 scarabeus 1.32 ${EGIT_DIFFSTAT_CMD} ${oldsha1}..origin/${EGIT_BRANCH}
286     popd &> /dev/null
287 ferdy 1.1 fi
288 scarabeus 1.32
289     pushd "${GIT_DIR}" &> /dev/null
290 ferdy 1.6 if ${EGIT_REPACK} || ${EGIT_PRUNE} ; then
291     ebegin "Garbage collecting the repository"
292     git gc $(${EGIT_PRUNE} && echo '--prune')
293 ferdy 1.1 eend $?
294     fi
295 scarabeus 1.32 popd &> /dev/null
296 maekke 1.30
297 scarabeus 1.26 # export the git version
298     export EGIT_VERSION="${cursha1}"
299 ferdy 1.1
300 scarabeus 1.32 [[ ${EGIT_COMMIT} != ${EGIT_BRANCH} ]] && elog " commit: ${EGIT_COMMIT}"
301 scarabeus 1.17 ${elogcmd} " branch: ${EGIT_BRANCH}"
302 scarabeus 1.34 ${elogcmd} " storage directory: \"${GIT_DIR}\""
303    
304 scarabeus 1.35 # unpack to the ${S}
305 scarabeus 1.34 popd &> /dev/null
306 scarabeus 1.35 debug-print "git clone -l \"${GIT_DIR}\" \"${S}\""
307     git clone -l "${GIT_DIR}" "${S}"
308 maekke 1.30
309 scarabeus 1.23 # set correct branch and the tree ebuild specified
310 scarabeus 1.17 pushd "${S}" > /dev/null
311 scarabeus 1.23 local branchname=branch-${EGIT_BRANCH} src=origin/${EGIT_BRANCH}
312 scarabeus 1.32 if [[ ${EGIT_COMMIT} != ${EGIT_BRANCH} ]]; then
313     branchname=tree-${EGIT_COMMIT}
314     src=${EGIT_COMMIT}
315 scarabeus 1.23 fi
316     debug-print "git checkout -b ${branchname} ${src}"
317     git checkout -b ${branchname} ${src} 2>&1 > /dev/null
318 scarabeus 1.32 git_sumbodules
319 scarabeus 1.17 popd > /dev/null
320    
321 scarabeus 1.23 unset branchname src
322 vapier 1.5
323     echo ">>> Unpacked to ${S}"
324 ferdy 1.1 }
325    
326 scarabeus 1.17 # @FUNCTION: git_bootstrap
327     # @DESCRIPTION:
328     # Runs bootstrap command if EGIT_BOOTSTRAP variable contains some value
329     # Remember that what ever gets to the EGIT_BOOTSTRAP variable gets evaled by bash.
330 ferdy 1.1 git_bootstrap() {
331 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
332 ferdy 1.1
333 scarabeus 1.17 if [[ -n ${EGIT_BOOTSTRAP} ]] ; then
334     pushd "${S}" > /dev/null
335     einfo "Starting bootstrap"
336 ferdy 1.1
337 scarabeus 1.17 if [[ -f ${EGIT_BOOTSTRAP} ]]; then
338     # we have file in the repo which we should execute
339     debug-print "$FUNCNAME: bootstraping with file \"${EGIT_BOOTSTRAP}\""
340    
341     if [[ -x ${EGIT_BOOTSTRAP} ]]; then
342     eval "./${EGIT_BOOTSTRAP}" \
343     || die "${EGIT}: bootstrap script failed"
344 ferdy 1.1 else
345 scarabeus 1.17 eerror "\"${EGIT_BOOTSTRAP}\" is not executable."
346     eerror "Report upstream, or bug ebuild maintainer to remove bootstrap command."
347     die "${EGIT}: \"${EGIT_BOOTSTRAP}\" is not executable."
348 ferdy 1.1 fi
349 scarabeus 1.17 else
350     # we execute some system command
351     debug-print "$FUNCNAME: bootstraping with commands \"${EGIT_BOOTSTRAP}\""
352 ferdy 1.1
353 scarabeus 1.17 eval "${EGIT_BOOTSTRAP}" \
354     || die "${EGIT}: bootstrap commands failed."
355 ferdy 1.1
356     fi
357 scarabeus 1.17
358     einfo "Bootstrap finished"
359     popd > /dev/null
360 ferdy 1.1 fi
361 scarabeus 1.17 }
362 ferdy 1.1
363 scarabeus 1.17 # @FUNCTION: git_apply_patches
364     # @DESCRIPTION:
365     # Apply patches from EGIT_PATCHES bash array.
366     # Preffered is using the variable as bash array but for now it allows to write
367     # it also as normal space separated string list. (This part of code should be
368     # removed when all ebuilds get converted on bash array).
369     git_apply_patches() {
370     debug-print-function ${FUNCNAME} "$@"
371    
372     pushd "${S}" > /dev/null
373     if [[ ${#EGIT_PATCHES[@]} -gt 1 ]] ; then
374     for i in "${EGIT_PATCHES[@]}"; do
375     debug-print "$FUNCNAME: git_autopatch: patching from ${i}"
376     epatch "${i}"
377     done
378     elif [[ ${EGIT_PATCHES} != "" ]]; then
379     # no need for loop if space separated string is passed.
380     debug-print "$FUNCNAME: git_autopatch: patching from ${EGIT_PATCHES}"
381     epatch "${EGIT_PATCHES}"
382     fi
383    
384     popd > /dev/null
385 ferdy 1.1 }
386    
387 scarabeus 1.17 # @FUNCTION: git_src_unpack
388     # @DESCRIPTION:
389     # src_upack function, calls src_prepare one if EAPI!=2.
390     git_src_unpack() {
391     debug-print-function ${FUNCNAME} "$@"
392 ferdy 1.1
393 scarabeus 1.17 git_fetch || die "${EGIT}: unknown problem in git_fetch()."
394 ferdy 1.1
395 scarabeus 1.17 has src_prepare ${EXPORTED_FUNCTIONS} || git_src_prepare
396     }
397 ferdy 1.1
398 scarabeus 1.17 # @FUNCTION: git_src_prepare
399     # @DESCRIPTION:
400     # src_prepare function for git stuff. Patches, bootstrap...
401     git_src_prepare() {
402     debug-print-function ${FUNCNAME} "$@"
403 maekke 1.30
404 scarabeus 1.17 git_apply_patches
405     git_bootstrap
406 ferdy 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20