diff options
author | Gilles Dartiguelongue <eva@gentoo.org> | 2011-04-09 13:14:06 +0000 |
---|---|---|
committer | Gilles Dartiguelongue <eva@gentoo.org> | 2011-04-09 13:14:06 +0000 |
commit | 9b3779c3d5268fcff66ad5d4aabd0c67c609f80e (patch) | |
tree | fd2f6304384e55d746e97d89367224d903de0d02 /eclass | |
parent | Clean up old revision. (diff) | |
download | gentoo-2-9b3779c3d5268fcff66ad5d4aabd0c67c609f80e.tar.gz gentoo-2-9b3779c3d5268fcff66ad5d4aabd0c67c609f80e.tar.bz2 gentoo-2-9b3779c3d5268fcff66ad5d4aabd0c67c609f80e.zip |
Add eclass documentation.
Diffstat (limited to 'eclass')
-rw-r--r-- | eclass/gnome2.eclass | 77 |
1 files changed, 64 insertions, 13 deletions
diff --git a/eclass/gnome2.eclass b/eclass/gnome2.eclass index e0da7e4fcc58..c569fe4fafd5 100644 --- a/eclass/gnome2.eclass +++ b/eclass/gnome2.eclass @@ -1,16 +1,14 @@ -# Copyright 1999-2006 Gentoo Foundation +# Copyright 1999-2011 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 -# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2.eclass,v 1.90 2010/12/07 06:20:40 eva Exp $ +# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2.eclass,v 1.91 2011/04/09 13:14:06 eva Exp $ -# -# gnome2.eclass -# +# @ECLASS: gnome2.eclass +# @MAINTAINER: +# gnome@gentoo.org +# @BLURB: +# @DESCRIPTION: # Exports portage base functions used by ebuilds written for packages using the # GNOME framework. For additional functions, see gnome2-utils.eclass. -# -# Maintained by Gentoo's GNOME herd <gnome@gentoo.org> -# - inherit fdo-mime libtool gnome.org gnome2-utils @@ -24,18 +22,45 @@ case "${EAPI:-0}" in *) die "EAPI=${EAPI} is not supported" ;; esac +# @ECLASS-VARIABLE: G2CONF +# @DEFAULT-UNSET +# @DESCRIPTION: # Extra configure opts passed to econf G2CONF=${G2CONF:-""} +# @ECLASS-VARIABLE: ELTCONF +# @DEFAULT-UNSET +# @DESCRIPTION: # Extra options passed to elibtoolize ELTCONF=${ELTCONF:-""} +# @ECLASS-VARIABLE: USE_EINSTALL +# @DEFAULT-UNSET +# @DEPRECATED +# @DESCRIPTION: # Should we use EINSTALL instead of DESTDIR USE_EINSTALL=${USE_EINSTALL:-""} -# Run scrollkeeper for this package? +# @ECLASS-VARIABLE: USE_EINSTALL +# @DEPRECATED +# @DESCRIPTION: +# Whether to run scrollkeeper for this package or not. SCROLLKEEPER_UPDATE=${SCROLLKEEPER_UPDATE:-"1"} +# @ECLASS-VARIABLE: DOCS +# @DEFAULT-UNSET +# @DESCRIPTION: +# String containing documents passed to dodoc command. + +# @ECLASS-VARIABLE: GCONF_DEBUG +# @DEFAULT_UNSET +# @DESCRIPTION: +# Whether to handle debug or not. +# Some gnome applications support various levels of debugging (yes, no, minimum, +# etc), but using --disable-debug also removes g_assert which makes debugging +# harder. This variable should be set to yes for such packages for the eclass +# to handle it properly. It will enable minimal debug with USE=-debug. +# Note that this is most commonly found in configure.ac as GNOME_DEBUG_CHECK. if [[ ${GCONF_DEBUG} != "no" ]]; then @@ -43,13 +68,18 @@ if [[ ${GCONF_DEBUG} != "no" ]]; then fi - +# @FUNCTION: gnome2_src_unpack +# @DESCRIPTION: +# Stub function for old EAPI. gnome2_src_unpack() { unpack ${A} cd "${S}" has ${EAPI:-0} 0 1 && gnome2_src_prepare } +# @FUNCTION: gnome2_src_prepare +# @DESCRIPTION: +# Fix build of scrollkeeper documentation and run elibtoolize. gnome2_src_prepare() { # Prevent scrollkeeper access violations gnome2_omf_fix @@ -58,6 +88,9 @@ gnome2_src_prepare() { elibtoolize ${ELTCONF} } +# @FUNCTION: gnome2_src_configure +# @DESCRIPTION: +# Gnome specific configure handling gnome2_src_configure() { # Update the GNOME configuration options if [[ ${GCONF_DEBUG} != 'no' ]] ; then @@ -78,11 +111,18 @@ gnome2_src_configure() { GST_REGISTRY="${S}/registry.xml" econf "$@" ${G2CONF} || die "configure failed" } +# @FUNCTION: gnome2_src_compile +# @DESCRIPTION: +# Stub function for old EAPI. gnome2_src_compile() { has ${EAPI:-0} 0 1 && gnome2_src_configure "$@" emake || die "compile failure" } +# @FUNCTION: gnome2_src_install +# @DESCRIPTION: +# Gnome specific install. Handles typical GConf and scrollkeeper setup +# in packages. gnome2_src_install() { has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}" # if this is not present, scrollkeeper-update may segfault and @@ -121,12 +161,19 @@ gnome2_src_install() { rm -fr "${ED}/usr/share/applications/mimeinfo.cache" } +# @FUNCTION: gnome2_pkg_preinst +# @DESCRIPTION: +# Finds Icons, GConf and GSettings schemas for later handling in pkg_postinst gnome2_pkg_preinst() { gnome2_gconf_savelist gnome2_icon_savelist gnome2_schemas_savelist } +# @FUNCTION: gnome2_pkg_postinst +# @DESCRIPTION: +# Handle scrollkeeper, GConf, GSettings, Icons, desktop and mime +# database updates. gnome2_pkg_postinst() { gnome2_gconf_install fdo-mime_desktop_database_update @@ -139,10 +186,16 @@ gnome2_pkg_postinst() { fi } +# @#FUNCTION: gnome2_pkg_prerm +# @#DESCRIPTION: +# # FIXME Handle GConf schemas removal #gnome2_pkg_prerm() { # gnome2_gconf_uninstall #} +# @FUNCTION: gnome2_pkg_postrm +# @DESCRIPTION: +# Handle scrollkeeper, GSettings, Icons, desktop and mime database updates. gnome2_pkg_postrm() { fdo-mime_desktop_database_update fdo-mime_mime_database_update @@ -153,5 +206,3 @@ gnome2_pkg_postrm() { gnome2_scrollkeeper_update fi } - -# pkg_prerm |