FAQ Search Today's Posts Mark Forums Read
» Video Reviews

» Linux Archive

Linux-archive is a website aiming to archive linux email lists and to make them easily accessible for linux users/developers.


» Sponsor

» Partners

» Sponsor

Go Back   Linux Archive > Gentoo > Gentoo Development

 
 
LinkBack Thread Tools
 
Old 02-06-2011, 02:44 PM
Tomáš Chvátal
 
Default git-2.eclass review phase one

Hello,
so this is first attempt to create new eclass for git management that is
more clean and neat. I would like to ask you guys to help me review it
and suggest updates/cleanups.

I really tried to make the eclass nicely separated to functions based on
what it does and remove some obsolete code. During that i also removed
the need for the src_prepare.

All the replies will be updated in kde overlay eclass folder where you
can find git-2.eclass right now. So I wont be replying the mails with
further patch files.

Cheers

Tom
# Copyright 1999-2011 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $

# @ECLASS: git-2.eclass
# @MAINTAINER:
# Tomas Chvatal <scarabeus@gentoo.org>
# @BLURB: This eclass provides functions for fetch and unpack git repositories
# @DESCRIPTION:
# Eclass for easing maitenance of live ebuilds using git as remote repositories.
# Eclass support working with git submodules and branching.

# This eclass support all EAPIs
EXPORT_FUNCTIONS src_unpack

DEPEND="dev-vcs/git"

# This static variable is for storing the data in WORKDIR.
# Sometimes we might want to redefine S.
EGIT_SOURCEDIR="${WORKDIR}/${P}"

# @FUNCTION: git-2_init_variables
# @DESCRIPTION:
# Internal function initializing all git variables.
# We define it in function scope so user can define
# all the variables before and after inherit.
git-2_init_variables() {
debug-print-function ${FUNCNAME} "$@"

# @ECLASS-VARIABLE: ESCM_STORE_DIR
# @DESCRIPTION:
# Storage directory for git sources.
: ${ESCM_STORE_DIR:="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/egit-src"}

# @ECLASS-VARIABLE: EGIT_HAS_SUBMODULES
# @DESCRIPTION:
# Set this to non-empty value to enable submodule support (slower).
: ${EGIT_HAS_SUBMODULES:=}

# @ECLASS-VARIABLE: ESCM_FETCH_CMD
# @DESCRIPTION:
# Command for cloning the repository.
: ${ESCM_FETCH_CMD:="git clone"}

# @ECLASS-VARIABLE: ESCM_UPDATE_CMD
# @DESCRIPTION:
# Git fetch command.
if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
ESCM_UPDATE_CMD="git pull -f -u"
else
ESCM_UPDATE_CMD="git fetch -t -f -u"
fi

# @ECLASS-VARIABLE: ESCM_OPTIONS
# @DESCRIPTION:
# This variable value is passed to clone and fetch.
: ${ESCM_OPTIONS:=}

# @ECLASS-VARIABLE: ESCM_MASTER
# @DESCRIPTION:
# Variable for specifying master branch.
# Usefull when upstream don't have master branch.
: ${ESCM_MASTER:=master}

# @ECLASS-VARIABLE: ESCM_REPO_URI
# @DESCRIPTION:
# URI for the repository
# e.g. http://foo, git://bar
# Supported protocols:
# http://
# https://
# git://
# git+ssh://
# rsync://
# ssh://
eval X="$${PN//[-+]/_}_LIVE_REPO"
if [[ ${X} = "" ]]; then
: ${ESCM_REPO_URI:=}
else
ESCM_REPO_URI="${X}"
fi
[[ -z ${ESCM_REPO_URI} ]] && die "ESCM_REPO_URI must have some value."
if [[ -z ${ESCM_REPO_URI%%:*} ]] ; then
case ${ESCM_REPO_URI%%:*} in
git*|http|https|rsync|ssh) ;;
*) die "Protocol for fetch from "${ESCM_REPO_URI%:*}" is not yet implemented in eclass." ;;
esac
fi

# @ECLASS-VARIABLE: ESCM_OFFLINE
# @DESCRIPTION:
# Set this variable to a non-empty value to disable the automatic updating of
# an GIT source tree. This is intended to be set outside the git source
# tree by users.
: ${ESCM_OFFLINE:=${ESCM_OFFLINE}}

# @ECLASS-VARIABLE: ESCM_BRANCH
# @DESCRIPTION:
# Specify the branch we want to check out from the repository
eval X="$${PN//[-+]/_}_LIVE_BRANCH"
if [[ "${X}" = "" ]]; then
: ${ESCM_BRANCH:=${ESCM_MASTER}}
else
ESCM_BRANCH="${X}"
fi

# @ECLASS-VARIABLE: ESCM_COMMIT
# @DESCRIPTION:
# Specify commit we want to check out from the repository.
eval X="$${PN//[-+]/_}_LIVE_COMMIT"
if [[ "${X}" = "" ]]; then
: ${ESCM_COMMIT:=${ESCM_BRANCH}}
else
ESCM_COMMIT="${X}"
fi

# @ECLASS-VARIABLE: EGIT_REPACK
# @DESCRIPTION:
# Set to non-empty value to repack objects to save disk space. However this can
# take a REALLY LONG time with VERY big repositories.
: ${EGIT_REPACK:=}

# @ECLASS-VARIABLE: EGIT_PRUNE
# @DESCRIPTION:
# Set to non-empty value to prune loose objects on each fetch. This is useful
# if upstream rewinds and rebases branches often.
: ${EGIT_PRUNE:=}

}

# @FUNCTION: git-2_submodules
# @DESCRIPTION:
# Internal function wrapping the submodule initialisation and update
git-2_submodules() {
debug-print-function ${FUNCNAME} "$@"

[[ "$#" -ne 1 ]] && die "${FUNCNAME}: requires 1 argument (path)"

debug-print "${FUNCNAME}: working in "${1}""
pushd "${1}" &> /dev/null

# for submodules operations we need to be online
if [[ -z ${ESCM_OFFLINE} && -n ${EGIT_HAS_SUBMODULES} ]]; then
export GIT_DIR=${EGIT_DIR}
debug-print "${FUNCNAME}: git submodule init"
git submodule init || die "${FUNCNAME}: git submodule initialisation failed"
debug-print "${FUNCNAME}: git submodule sync"
git submodule sync "" die "${FUNCNAME}: git submodule sync failed"
debug-print "${FUNCNAME}: git submodule update"
git submodule update || die "${FUNCNAME}: git submodule update failed"
unset GIT_DIR
fi

popd > /dev/null
}

# @FUNCTION: git-2_branch
# @DESCRIPTION:
# Internal function that changes branch for the repo based on ESCM_COMMIT and
# ESCM_BRANCH variables.
git-2_branch() {
debug-print-function ${FUNCNAME} "$@"

debug-print "${FUNCNAME}: working in "${EGIT_SOURCEDIR}""
pushd "${EGIT_SOURCEDIR}" &> /dev/null

local branchname=branch-${ESCM_BRANCH} src=origin/${ESCM_BRANCH}
if [[ "${ESCM_COMMIT}" != "${ESCM_BRANCH}" ]]; then
branchname=tree-${ESCM_COMMIT}
src=${ESCM_COMMIT}
fi
debug-print "${FUNCNAME}: git checkout -b ${branchname} ${src}"
git checkout -b ${branchname} ${src} || die "${FUNCNAME}: changing the branch failed"

popd > /dev/null

unset branchname src
}

# @FUNCTION: git-2_gc
# @DESCRIPTION:
# Internal function running garbage collector on checked out tree.
git-2_gc() {
debug-print-function ${FUNCNAME} "$@"

pushd "${EGIT_DIR}" &> /dev/null
if [[ -n ${EGIT_REPACK} || -n ${EGIT_PRUNE} ]]; then
ebegin "Garbage collecting the repository"
local args
[[ -n ${EGIT_PRUNE} ]] && args='--prune'
debug-print "${FUNCNAME}: git gc ${args}"
git gc ${args}
eend $?
fi
popd &> /dev/null
}

# @FUNCTION: git-2_prepare_storedir
# @DESCRIPTION:
# Internal function preparing directory where we are going to store SCM repository.
git-2_prepare_storedir() {
debug-print-function ${FUNCNAME} "$@"

local clone_dir

# initial clone, we have to create master git storage directory and play
# nicely with sandbox
if [[ ! -d "${ESCM_STORE_DIR}" ]] ; then
debug-print "${FUNCNAME}: Creating git main storage directory"
addwrite "${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}"
mkdir -p "${ESCM_STORE_DIR}"
|| die "${FUNCNAME}: can't mkdir "${ESCM_STORE_DIR}"."
fi

cd -P "${ESCM_STORE_DIR}" || die "${FUNCNAME}: can't chdir to "${ESCM_STORE_DIR}""
# allow writing into ESCM_STORE_DIR
addwrite "${ESCM_STORE_DIR}"
# calculate the proper store dir for data
[[ -z ${ESCM_REPO_URI##*/} ]] && ESCM_REPO_URI="${ESCM_REPO_URI%/}"
clone_dir="${ESCM_REPO_URI##*/}"
export EGIT_DIR="${ESCM_STORE_DIR}/${clone_dir}"
debug-print "${FUNCNAME}: Storing the repo into "${EGIT_DIR}"."

# we can not jump between using and not using SUBMODULES so we need to
# refetch the source when needed
if [[ -n ${EGIT_HAS_SUBMODULES} && -d "${EGIT_DIR}" && ! -d "${EGIT_DIR}"/.git ]]; then
debug-print "${FUNCNAME}: "${clone_dir}" was bare copy removing..."
rm -rf "${EGIT_DIR}"
fi
if [[ -z ${EGIT_HAS_SUBMODULES} && -d "${EGIT_DIR}" && -d "${EGIT_DIR}"/.git ]]; then
debug-print "${FUNCNAME}: "${clone_dir}" was not copy removing..."
rm -rf "${EGIT_DIR}"
fi
}

# @FUNCTION: git-2_move_source
# @DESCRIPTION:
# Internal function moving sources from the EGIT_DIR to EGIT_SOURCEDIR dir.
git-2_move_source() {
debug-print-function ${FUNCNAME} "$@"

if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
pushd "${EGIT_DIR}" &> /dev/null
debug-print "${FUNCNAME}: rsync -rlpgo . "${EGIT_SOURCEDIR}""
rsync -rlpgo . "${EGIT_SOURCEDIR}" || die "${FUNCNAME}: sync of git data to "${EGIT_SOURCEDIR}" failed"
popd &> /dev/null
else
debug-print "${FUNCNAME}: git clone -l -s -n "${EGIT_DIR}" "${EGIT_SOURCEDIR}""
git clone -l -s -n "${EGIT_DIR}" "${EGIT_SOURCEDIR}" || die "${FUNCNAME}: sync of git data to "${EGIT_SOURCEDIR}" failed"
fi
}


# @FUNCTION: git-2_fetch
# @DESCRIPTION:
# Internal function fetching repository from ESCM_REPO_URI and storing it in specified ESCM_STORE_DIR.
git-2_fetch() {
debug-print-function ${FUNCNAME} "$@"

local oldsha1 cursha1 extra_clone_opts upstream_branch

if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
upstream_branch=origin/${ESCM_BRANCH}
else
upstream_branch=${ESCM_BRANCH}
extra_clone_opts="--bare"
fi

if [[ ! -d ${EGIT_DIR} ]] ; then
# first clone
einfo "GIT NEW clone -->"
einfo " repository: ${ESCM_REPO_URI}"

debug-print "${ESCM_FETCH_CMD} ${extra_clone_opts} ${ESCM_OPTIONS} "${ESCM_REPO_URI}" "${EGIT_DIR}""
${ESCM_FETCH_CMD} ${extra_clone_opts} ${ESCM_OPTIONS} "${ESCM_REPO_URI}" "${EGIT_DIR}"
|| die "${FUNCNAME}: can't fetch from ${ESCM_REPO_URI}."

pushd "${EGIT_DIR}" &> /dev/null
cursha1=$(git rev-parse ${upstream_branch})
einfo " at the commit: ${cursha1}"

git-2_submodules "${EGIT_DIR}"
popd &> /dev/null
elif [[ -n ${ESCM_OFFLINE} ]] ; then
pushd "${EGIT_DIR}" &> /dev/null
cursha1=$(git rev-parse ${upstream_branch})
einfo "GIT offline update -->"
einfo " repository: ${ESCM_REPO_URI}"
einfo " at the commit: ${cursha1}"
popd &> /dev/null
else
pushd "${EGIT_DIR}" &> /dev/null
# Git urls might change, so unconditionally set it here
git config remote.origin.url "${ESCM_REPO_URI}"

# fetch updates
einfo "GIT update -->"
einfo " repository: ${ESCM_REPO_URI}"

oldsha1=$(git rev-parse ${upstream_branch})

if [[ -n ${EGIT_HAS_SUBMODULES} ]]; then
debug-print "${ESCM_UPDATE_CMD} ${ESCM_OPTIONS}"
# fix branching
git checkout ${ESCM_MASTER}
for x in $(git branch |grep -v "* ${ESCM_MASTER}" |tr '
' ' '); do
git branch -D ${x}
done
${ESCM_UPDATE_CMD} ${ESCM_OPTIONS}
|| die "${FUNCNAME}: can't update from ${ESCM_REPO_URI}."
else
debug-print "${ESCM_UPDATE_CMD} ${ESCM_OPTIONS} origin ${ESCM_BRANCH}:${ESCM_BRANCH}"
${ESCM_UPDATE_CMD} ${ESCM_OPTIONS} origin ${ESCM_BRANCH}:${ESCM_BRANCH}
|| die "${FUNCNAME}: can't update from ${ESCM_REPO_URI}."
fi

git-2_submodules "${EGIT_DIR}"
cursha1=$(git rev-parse ${upstream_branch})

# write out message based on the revisions
if [[ "${oldsha1}" != "${cursha1}" ]]; then
einfo " updating from commit: ${oldsha1}"
einfo " to commit: ${cursha1}"
else
einfo " at the commit: ${cursha1}"
fi
git --no-pager diff --stat ${oldsha1}..${upstream_branch}
popd &> /dev/null
fi
# export the version the repository is at
export ESCM_VERSION="${cursha1}"
# log the repo state
[[ "${ESCM_COMMIT}" != "${ESCM_BRANCH}" ]] && einfo " commit: ${ESCM_COMMIT}"
einfo " branch: ${ESCM_BRANCH}"
einfo " storage directory: "${EGIT_DIR}""
}

# @FUNCTION: git_bootstrap
# @DESCRIPTION:
# Internal function that runs bootstrap command on unpacked source.
git-2_bootstrap() {
debug-print-function ${FUNCNAME} "$@"

# @ECLASS_VARIABLE: ESCM_BOOTSTRAP
# @DESCRIPTION:
# Command to be executed after checkout and clone of the specified
# repository.
# enviroment the package will fail if there is no update, thus in
# combination with --keep-going it would lead in not-updating
# pakcages that are up-to-date.
if [[ -n ${ESCM_BOOTSTRAP} ]] ; then
pushd "${EGIT_SOURCEDIR}" &> /dev/null
einfo "Starting bootstrap"

if [[ -f ${ESCM_BOOTSTRAP} ]]; then
# we have file in the repo which we should execute
debug-print "${FUNCNAME}: bootstraping with file "${ESCM_BOOTSTRAP}""

if [[ -x ${ESCM_BOOTSTRAP} ]]; then
eval "./${ESCM_BOOTSTRAP}"
|| die "${FUNCNAME}: bootstrap script failed"
else
eerror ""${ESCM_BOOTSTRAP}" is not executable."
eerror "Report upstream, or bug ebuild maintainer to remove bootstrap command."
die ""${ESCM_BOOTSTRAP}" is not executable."
fi
else
# we execute some system command
debug-print "${FUNCNAME}: bootstraping with commands "${ESCM_BOOTSTRAP}""

eval "${ESCM_BOOTSTRAP}"
|| die "${FUNCNAME}: bootstrap commands failed."
fi

einfo "Bootstrap finished"
popd > /dev/null
fi
}

# @FUNCTION: git-2_src_unpack
# @DESCRIPTION:
# src_upack function
git-2_src_unpack() {
debug-print-function ${FUNCNAME} "$@"

git-2_init_variables
git-2_prepare_storedir
git-2_fetch $@
git-2_gc
git-2_move_source
git-2_branch
git-2_submodules "${EGIT_SOURCEDIR}"
git-2_bootstrap
echo ">>> Unpacked to ${EGIT_SOURCEDIR}"
}
 
Old 02-06-2011, 03:21 PM
Ulrich Mueller
 
Default git-2.eclass review phase one

> # Eclass for easing maitenance of live ebuilds using git as remote repositories.

Please keep lines below 80 characters if possible.

> # @ECLASS-VARIABLE: ESCM_STORE_DIR
> # @DESCRIPTION:
> # Storage directory for git sources.
> : ${ESCM_STORE_DIR:="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/egit-src"}

Why is this renamed? It was EGIT_STORE_DIR before, and I think that
was more appropriate, especially when it's named egit-src.

> # @ECLASS-VARIABLE: ESCM_FETCH_CMD
> # @ECLASS-VARIABLE: ESCM_UPDATE_CMD
> # @ECLASS-VARIABLE: ESCM_OPTIONS
> # @ECLASS-VARIABLE: ESCM_MASTER
> # @ECLASS-VARIABLE: ESCM_REPO_URI
> # @ECLASS-VARIABLE: ESCM_BRANCH
> # @ECLASS-VARIABLE: ESCM_COMMIT

Same for all of these, they are all specific to git and should
therefore be named EGIT_*. Other VCSs have different concepts for some
of them.

> if [[ -z ${ESCM_REPO_URI%%:*} ]] ; then
> case ${ESCM_REPO_URI%%:*} in
> git*|http|https|rsync|ssh) ;;
> *) die "Protocol for fetch from "${ESCM_REPO_URI%:*}" is not yet implemented in eclass." ;;
> esac
> fi

This test won't work as intended.

> addwrite "${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}"
> mkdir -p "${ESCM_STORE_DIR}"

Is it guaranteed that ${ESCM_STORE_DIR} is a subdir of
${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}} if the former is freely
configurable?

Ulrich
 
Old 02-06-2011, 03:52 PM
James Cloos
 
Default git-2.eclass review phase one

> # we can not jump between using and not using SUBMODULES so we need to
> # refetch the source when needed

In that section, please do not rm(1) the existing clone; move it out of
the way just like portage does when checksums fail.

Nothing under DISTDIR should /ever/ be subject to behind-the-back deletion.

Also, and if I read that right, you use clone to copy the src for
building only when EGIT_HAS_SUBMODULES is true, yes? Please use clone
for the other case, too. Letting the package's build system know that
it is building directly from a the repo is a /good thing/.

-JimC
--
James Cloos <cloos@jhcloos.com> OpenPGP: 1024D/ED7DAEA6
 

Thread Tools




All times are GMT. The time now is 04:46 PM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.
Copyright 2007 - 2008, www.linux-archive.org