[gentoo-dev] Major changes to gdesklets.eclass

[Joe Sapp <nixphoeni@gentoo.org>]

[-- Attachment #1.1: Type: text/plain, Size: 1113 bytes --]

Hi all,

I've been wanting to make some changes to this eclass for a while since I've
been putting on some bandages to make things work.  This is a rather major
overhaul.  Basically packaging upstream got a lot more regulated since obz and
I wrote the original eclass [1], so we can simplify many things.  This results
in trivial ebuilds, ease of maintaining, quicker installs, and (I think) a
better user interface.

Anyways, a diff would be useless so I've attached the proposed eclass [2].

My plan for updating the tree is as follows:
 1) Wait until at least 25 January 2010, discussing on the gentoo-dev ml
 2) As long as there are no pending items for review, I will test with all
current x11-plugins/desklet-* ebuilds, diffing the "old" and "new" directories
 3) Commit the new eclass
 4) Tweak the x11-plugins/desklet-* ebuilds to remove unneeded variables

Please let me know what you think.

Thanks,
Joe

--
[1]
http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/gdesklets.eclass?view=markup
[2] http://dev.gentoo.org/~nixphoeni/gdesklets/eclass/gdesklets-20091101.eclass

[-- Attachment #1.2: gdesklets-20091101.eclass --]
[-- Type: text/plain, Size: 5420 bytes --]

# Copyright 2004-2009 Gentoo Foundation
# Distributed under the terms of the GNU General Public License, v2 or later
# $Header: $

# @ECLASS: gdesklets.eclass
# @MAINTAINER:
# gdesklets@gentoo.org
# @BLURB: Installation functions for Desklets and Controls supported
# by gDesklets
# @DESCRIPTION:
# The gdesklets eclass provides a simple way to create ebuilds for
# globally installing desktop applets ("Desklets") and supporting code
# ("Controls") used in the gDesklets framework (provided by
# gnome-extra/gdesklets-core)
#
# This eclass assumes a package following the instructions at
# http://gdesklets.de/index.php?q=node/2 .  Specifically, the package
# should be a Desklet or Control ONLY (and *not* a Sensor).  You
# technically could have an ebuild that works around this limitation,
# but no new packages should be added to the tree that do this (mainly
# for ease of maintenance).
#
# Original authors:	Joe Sapp <nixphoeni@gentoo.org>
#			Mike Gardiner <obz@gentoo.org>

# @ECLASS_VARIABLE: DESKLET_NAME
# @DESCRIPTION:
# *Optional*  The name of the Desklet, if the package is one. The
# default is to assume a Desklet with the name being ${PN} without the
# "desklet-" prefix.

# @ECLASS_VARIABLE: CONTROL_NAME
# @DESCRIPTION:
# *Optional*  The name of the Control, if the package is one.

# @ECLASS_VARIABLE: DOCS
# @DESCRIPTION:
# Anything (like a README) that should be dodoc'd.

# @ECLASS_VARIABLE: SLOT
# @DESCRIPTION:
# Set only if the package is a Control and it provides a different
# interface (i.e. expands to a different install directory) than a
# previous version.

inherit eutils multilib python

if [[ -n "${CONTROL_NAME}" ]]; then
	debug-print "Looking for a Control named \"${CONTROL_NAME}\""
	MY_PN="${CONTROL_NAME}"
	SRC_URI="http://gdesklets.de/files/controls/${MY_PN}/${MY_PN}-${PV}.tar.gz"
	unset DESKLET_NAME
else # [[ -n "${DESKLET_NAME}" ]]; then
	# Assume an unset DESKLET_NAME means the name is ${PN} without
	# the "desklet-" prefix
	[[ -z "${DESKLET_NAME}" ]] && DESKLET_NAME="${PN#desklet-}"
	debug-print "Looking for a Desklet named \"${DESKLET_NAME}\""
	MY_PN="${DESKLET_NAME}"
	SRC_URI="http://gdesklets.de/files/desklets/${MY_PN}/${MY_PN}-${PV}.tar.gz"
fi

MY_P="${MY_PN}-${PV}"
S="${WORKDIR}/${MY_PN}"

SLOT="0"
# Ebuild writer shouldn't need to touch these (except maybe RDEPEND)
IUSE=""
RDEPEND=">=gnome-extra/gdesklets-core-0.36.1-r3"

GDESKLETS_INST_DIR="${ROOT:-/}usr/$(get_libdir)/gdesklets"

# @FUNCTION: gdesklets_src_install
# @DESCRIPTION:
# Installs a Desklet or Control depending on which is set of
# CONTROL_NAME or DESKLET_NAME
gdesklets_src_install() {

	debug-print-function $FUNCNAME $*

	# Disable compilation of included python modules (for Controls)
	python_disable_pyc

	# Avoid sandbox violations caused by misbehaving packages (bug #128289)
	addwrite "${ROOT}/root/.gnome2"

	# Both Displays and Controls only need to be readable
	insopts -m0744

	# Check to see if DISPLAY is set for the
	# gdesklets-control-getid script to run without error
	[ -z "${DISPLAY}" ] && DISPLAY=""
	export DISPLAY

	debug-print-section docs_install

	# Install some docs if so requested (and then delete them so they
	# don't get copied into the installation directory)
	[[ -n "${DOCS}" ]] && dodoc ${DOCS} && \
		rm -f ${DOCS} \
		debug-print "Installed and deleted ${DOCS}"
	# LICENSE doesn't need to get installed if it exists
	find . -name LICENSE -delete

	if [[ -n "${DESKLET_NAME}" ]]; then

		debug-print-section display_install

		# Base installation directory for displays from this desklet
		INSDIR="${GDESKLETS_INST_DIR}/Displays/${DESKLET_NAME}"

		debug-print "Installing into ${INSDIR}"
		debug-print "Exiting Display-specific installation code"

	elif [[ -n "${CONTROL_NAME}" ]]; then

		debug-print-section control_install

		# Unique name for this Control and its interface
		CTRL_DIRNAME=$( "${GDESKLETS_INST_DIR}/gdesklets-control-getid" `pwd` )
		einfo "Installing Control ${CTRL_DIRNAME}"

		# Base installation directory for this Control
		INSDIR="${GDESKLETS_INST_DIR}/Controls/${CTRL_DIRNAME}"
		debug-print "Installing into ${INSDIR}"

		# Mercilessly delete all existing compiled code
		find . -iname '*.py[co]' -delete

		debug-print "Exiting Control-specific installation code"

	else
		die "nothing to install, is the ebuild written correctly?"
	fi

	debug-print-section common_install

	# Create the proper subdirectory in the global Controls or
	# Displays directory
	dodir "${INSDIR}"
	insinto "${INSDIR}"
	doins -r *

}

# @FUNCTION: gdesklets_pkg_postinst
# @DESCRIPTION:
# Marks the Control for rebuilding on Python version change and
# compiles the Python code or display a useful message to the user,
# depending on which of CONTROL_NAME or DESKLET_NAME is set.
gdesklets_pkg_postinst() {

	# The only time compilation of python modules should occur is
	# for Controls, since Displays are run from inside the sandbox
	# (and therefore can't be compiled).
	if [[ -n "${CONTROL_NAME}" ]]; then

		CTRL_DIRNAME=$( "${GDESKLETS_INST_DIR}/gdesklets-control-getid" `pwd` )
		python_need_rebuild
		python_mod_optimize "${GDESKLETS_INST_DIR}/Controls/${CTRL_DIRNAME}"

	else

		einfo "Each user can now add this desklet to their desktop through the"
		einfo "gDesklets shell or the command line (.display files can be"
		einfo "found in ${GDESKLETS_INST_DIR}/Displays/${DESKLET_NAME})."

	fi

}

EXPORT_FUNCTIONS src_install pkg_postinst

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 262 bytes --]