Gentoo Development Guide

KDE4-META.ECLASS

Section: portage (5)
Updated: May 2013
Index Return to Main Contents

NAME

kde4-meta.eclass - Eclass for writing "split" KDE packages.

DESCRIPTION

This eclass provides all necessary functions for writing split KDE ebuilds.

You must define KMNAME to use this eclass, and do so before inheriting it. All other variables are optional. Do not include the same item in more than one of KMMODULE, KMMEXTRA, KMCOMPILEONLY, KMEXTRACTONLY.

FUNCTIONS

kde4-meta_pkg_setup: Currently calls its equivalent in kde4-base.eclass(5) and checks the gcc version. Use this one in split ebuilds.
kde4-meta_src_unpack: This function unpacks the source for split ebuilds. Further more is processed in kde4-meta_src_extract
kde4-meta_src_extract: A function to extract the source for a split KDE ebuild. Also see KMMODULE, KMNOMODULE, KMEXTRA, KMCOMPILEONLY, KMEXTRACTONLY and KMTARPARAMS.
kde4-meta_create_extractlists: Create lists of files and subdirectories to extract. Also see descriptions of KMMODULE, KMNOMODULE, KMEXTRA, KMCOMPILEONLY, KMEXTRACTONLY and KMTARPARAMS.
kde4-meta_src_prepare: Meta-package build system configuration handling - commenting out targets, etc..
_change_cmakelists_parent_dirs: Adjust CMakeLists.txt to shadow subdirectories that are not required for the build.
kde4-meta_change_cmakelists: Adjust CMakeLists.txt to comply to our splitting.
kde4-meta_src_configure: Currently just calls its equivalent in kde4-base.eclass(5). Use this one in split ebuilds.
kde4-meta_src_compile: General function for compiling split KDE4 applications. Overrides kde4-base_src_compile.
kde4-meta_src_test: Currently just calls its equivalent in kde4-base.eclass(5) if I_KNOW_WHAT_I_AM_DOING is set. Use this in split ebuilds.
kde4-meta_src_install: Function for installing KDE4 split applications.
kde4-meta_pkg_preinst: Invoke its equivalent in kde4-base.eclass.
kde4-meta_pkg_postinst: Invoke kbuildsycoca4.
kde4-meta_pkg_postrm: Currently just calls its equivalent in kde4-base.eclass(5). Use this in split ebuilds.

ECLASS VARIABLES

KMNAME: Name of the parent-module (e.g. kdebase, kdepim, ...). You _must_ set it _before_ inheriting this eclass, (unlike the other parameters), since it's used to set $SRC_URI.
KMMODULE: Specify exactly one subdirectory of $KMNAME here. Defaults to $PN. The subdirectory listed here is treated exactly like items in $KMEXTRA.
Example: The ebuild name of "kdebase/l10n" is kde-base/kdebase-l10n, because just 'l10n' would be too confusing. Hence it sets KMMODULE="l10n".
KMNOMODULE: If set to "true", $KMMODULE doesn't have to be defined.
Example usage: If you're installing subdirectories of a package, like plugins, you mark the top subdirectory (containing the package) as $KMEXTRACTONLY, and set KMNOMODULE="true".
KMEXTRA: All subdirectories listed here will be extracted, compiled & installed. $KMMODULE is always added to $KMEXTRA. If KDE_HANDBOOK is 'always' or 'optional' and handbook USE-flag is set, and if this directory exists, then "doc/$KMMODULE" is added to $KMEXTRA. If there's additional documentation in different subdirectories, it should be added to KMEXTRA manually..
KMCOMPILEONLY: All subdirectories listed here will be extracted & compiled, but not installed.
KMEXTRACTONLY: All subdirectories listed here will be extracted, but neither compiled nor installed. This can be used to avoid compilation in a subdirectory of a directory in $KMMODULE or $KMEXTRA
KMTARPARAMS: Specify extra parameters to pass to tar, in kde4-meta_src_extract.

MAINTAINERS

kde@gentoo.org

REPORTING BUGS

Please report bugs via http://bugs.gentoo.org/

FILES

/usr/portage/eclass/kde4-meta.eclass

This document was created by man2html, using the manual pages.
Time: 03:25:02 GMT, May 18, 2013