1 # Copyright 1999-2014 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
5 # @ECLASS: mercurial.eclass
7 # Christoph Junghans <ottxor@gentoo.org>
8 # Dirkjan Ochtman <djc@gentoo.org>
10 # Next gen author: Krzysztof Pawlik <nelchael@gentoo.org>
11 # Original author: Aron Griffis <agriffis@gentoo.org>
12 # @BLURB: This eclass provides generic mercurial fetching functions
14 # This eclass provides generic mercurial fetching functions. To fetch sources
15 # from mercurial repository just set EHG_REPO_URI to correct repository URI. If
16 # you need to share single repository between several ebuilds set EHG_PROJECT to
17 # project name in all of them.
21 EXPORT_FUNCTIONS src_unpack
23 DEPEND="dev-vcs/mercurial"
25 # @ECLASS-VARIABLE: EHG_REPO_URI
27 # Mercurial repository URI.
29 # @ECLASS-VARIABLE: EHG_REVISION
31 # Create working directory for specified revision, defaults to default.
33 # EHG_REVISION is passed as a value for --updaterev parameter, so it can be more
34 # than just a revision, please consult `hg help revisions' for more details.
35 : ${EHG_REVISION:="default"}
37 # @ECLASS-VARIABLE: EHG_STORE_DIR
39 # Mercurial sources store directory. Users may override this in /etc/portage/make.conf
40 [[ -z "${EHG_STORE_DIR}" ]] && EHG_STORE_DIR="${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}/hg-src"
42 # @ECLASS-VARIABLE: EHG_PROJECT
46 # This variable default to $PN, but can be changed to allow repository sharing
47 # between several ebuilds.
48 [[ -z "${EHG_PROJECT}" ]] && EHG_PROJECT="${PN}"
50 # @ECLASS-VARIABLE: EGIT_CHECKOUT_DIR
52 # The directory to check the hg sources out to.
54 # EHG_CHECKOUT_DIR=${S}
56 # @ECLASS-VARIABLE: EHG_QUIET
58 # Suppress some extra noise from mercurial, set it to 'ON' to be quiet.
60 [[ "${EHG_QUIET}" == "ON" ]] && EHG_QUIET_CMD_OPT="--quiet"
62 # @ECLASS-VARIABLE: EHG_CLONE_CMD
64 # Command used to perform initial repository clone.
65 [[ -z "${EHG_CLONE_CMD}" ]] && EHG_CLONE_CMD="hg clone ${EHG_QUIET_CMD_OPT} --pull --noupdate"
67 # @ECLASS-VARIABLE: EHG_PULL_CMD
69 # Command used to update repository.
70 [[ -z "${EHG_PULL_CMD}" ]] && EHG_PULL_CMD="hg pull ${EHG_QUIET_CMD_OPT}"
72 # @ECLASS-VARIABLE: EHG_OFFLINE
74 # Set this variable to a non-empty value to disable the automatic updating of
75 # a mercurial source tree. This is intended to be set outside the ebuild by
77 EHG_OFFLINE="${EHG_OFFLINE:-${EVCS_OFFLINE}}"
79 # @FUNCTION: mercurial_fetch
80 # @USAGE: [repository_uri] [module] [sourcedir]
82 # Clone or update repository.
84 # If repository URI is not passed it defaults to EHG_REPO_URI, if module is
85 # empty it defaults to basename of EHG_REPO_URI, sourcedir defaults to
86 # EHG_CHECKOUT_DIR, which defaults to S.
89 debug-print-function ${FUNCNAME} "${@}"
91 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
93 EHG_REPO_URI=${1-${EHG_REPO_URI}}
94 [[ -z "${EHG_REPO_URI}" ]] && die "EHG_REPO_URI is empty"
96 local module="${2-$(basename "${EHG_REPO_URI}")}"
97 local sourcedir="${3:-${EHG_CHECKOUT_DIR:-${S}}}"
99 # Should be set but blank to prevent using $HOME/.hgrc
102 # Check ${EHG_STORE_DIR} directory:
103 addwrite "$(dirname "${EHG_STORE_DIR}")" || die "addwrite failed"
104 if [[ ! -d "${EHG_STORE_DIR}" ]]; then
105 mkdir -p "${EHG_STORE_DIR}" || die "failed to create ${EHG_STORE_DIR}"
106 chmod -f g+rw "${EHG_STORE_DIR}" || \
107 die "failed to chown ${EHG_STORE_DIR}"
110 # Create project directory:
111 mkdir -p "${EHG_STORE_DIR}/${EHG_PROJECT}" || \
112 die "failed to create ${EHG_STORE_DIR}/${EHG_PROJECT}"
113 chmod -f g+rw "${EHG_STORE_DIR}/${EHG_PROJECT}" || \
114 echo "Warning: failed to chmod g+rw ${EHG_PROJECT}"
115 cd "${EHG_STORE_DIR}/${EHG_PROJECT}" || \
116 die "failed to cd to ${EHG_STORE_DIR}/${EHG_PROJECT}"
118 # Clone/update repository:
119 if [[ ! -d "${module}" ]]; then
120 einfo "Cloning ${EHG_REPO_URI} to ${EHG_STORE_DIR}/${EHG_PROJECT}/${module}"
121 ${EHG_CLONE_CMD} "${EHG_REPO_URI}" "${module}" || {
123 die "failed to clone ${EHG_REPO_URI}"
126 elif [[ -z "${EHG_OFFLINE}" ]]; then
127 einfo "Updating ${EHG_STORE_DIR}/${EHG_PROJECT}/${module} from ${EHG_REPO_URI}"
128 cd "${module}" || die "failed to cd to ${module}"
129 ${EHG_PULL_CMD} "${EHG_REPO_URI}" || die "update failed"
132 # Checkout working copy:
133 einfo "Creating working directory in ${sourcedir} (target revision: ${EHG_REVISION})"
134 mkdir -p "${sourcedir}" || die "failed to create ${sourcedir}"
136 ${EHG_QUIET_CMD_OPT} \
137 --updaterev="${EHG_REVISION}" \
138 "${EHG_STORE_DIR}/${EHG_PROJECT}/${module}" \
139 "${sourcedir}" || die "hg clone failed"
140 # An exact revision helps a lot for testing purposes, so have some output...
142 # fd6e32d61721 6276 default
143 local HG_REVDATA=($(hg identify -b -i "${sourcedir}"))
144 export HG_REV_ID=${HG_REVDATA[0]}
145 local HG_REV_BRANCH=${HG_REVDATA[1]}
146 einfo "Work directory: ${sourcedir} global id: ${HG_REV_ID} (was ${EHG_REVISION} branch: ${HG_REV_BRANCH}"
149 # @FUNCTION: mercurial_bootstrap
152 # Internal function that runs bootstrap command on unpacked source.
153 mercurial_bootstrap() {
154 debug-print-function ${FUNCNAME} "$@"
156 # @ECLASS-VARIABLE: EHG_BOOTSTRAP
158 # Command to be executed after checkout and clone of the specified
160 if [[ ${EHG_BOOTSTRAP} ]]; then
161 pushd "${S}" > /dev/null
162 einfo "Starting bootstrap"
164 if [[ -f ${EHG_BOOTSTRAP} ]]; then
165 # we have file in the repo which we should execute
166 debug-print "${FUNCNAME}: bootstraping with file \"${EHG_BOOTSTRAP}\""
168 if [[ -x ${EHG_BOOTSTRAP} ]]; then
169 eval "./${EHG_BOOTSTRAP}" \
170 || die "${FUNCNAME}: bootstrap script failed"
172 eerror "\"${EHG_BOOTSTRAP}\" is not executable."
173 eerror "Report upstream, or bug ebuild maintainer to remove bootstrap command."
174 die "\"${EHG_BOOTSTRAP}\" is not executable"
177 # we execute some system command
178 debug-print "${FUNCNAME}: bootstraping with commands \"${EHG_BOOTSTRAP}\""
180 eval "${EHG_BOOTSTRAP}" \
181 || die "${FUNCNAME}: bootstrap commands failed"
184 einfo "Bootstrap finished"
189 # @FUNCTION: mercurial_src_unpack
191 # The mercurial src_unpack function, which will be exported.
192 function mercurial_src_unpack {
193 debug-print-function ${FUNCNAME} "$@"