Gentoo Development Guide

KDE4-BASE.ECLASS

Section: portage (5)
Updated: Jul 2014
Index Return to Main Contents
 

NAME

kde4-base.eclass - This eclass provides functions for kde 4.X ebuilds  

DESCRIPTION

The kde4-base.eclass provides support for building KDE4 based ebuilds and KDE4 applications.

NOTE: KDE 4 ebuilds currently support EAPIs 4 and 5. This will be reviewed over time as new EAPI versions are approved.  

FUNCTIONS

kde4-base_pkg_setup
Do some basic settings
kde4-base_src_unpack
This function unpacks the source tarballs for KDE4 applications.
kde4-base_src_prepare
General pre-configure and pre-compile function for KDE4 applications. It also handles translations if KDE_LINGUAS is defined. See KDE_LINGUAS and enable_selected_linguas() and enable_selected_doc_linguas() in kde4-functions.eclass(5) for further details.
kde4-base_src_configure
Function for configuring the build of KDE4 applications.
kde4-base_src_compile
General function for compiling KDE4 applications.
kde4-base_src_test
Function for testing KDE4 applications.
kde4-base_src_install
Function for installing KDE4 applications.
kde4-base_pkg_preinst
Function storing icon caches
kde4-base_pkg_postinst
Function to rebuild the KDE System Configuration Cache after an application has been installed.
kde4-base_pkg_postrm
Function to rebuild the KDE System Configuration Cache after an application has been removed.
 

ECLASS VARIABLES

KDE_SELINUX_MODULE ?= none
If set to "none", do nothing. For any other value, add selinux to IUSE, and depending on that useflag add a dependency on sec-policy/selinux-${KDE_SELINUX_MODULE} to (R)DEPEND
VIRTUALDBUS_TEST
If defined, launch and use a private dbus session during src_test.
VIRTUALX_REQUIRED ?= manual
For proper description see virtualx.eclass manpage. Here we redefine default value to be manual, if your package needs virtualx for tests you should proceed with setting VIRTUALX_REQUIRED=test.
CMAKE_REQUIRED ?= always
Specify if cmake buildsystem is being used. Possible values are 'always' and 'never'. Please note that if it's set to 'never' you need to explicitly override following phases: src_configure, src_compile, src_test and src_install. Defaults to 'always'.
KDE_MINIMAL = "${KDE_MINIMAL:-4.4}"
This variable is used when KDE_REQUIRED is set, to specify required KDE minimal version for apps to work. Currently defaults to 4.4 One may override this variable to raise version requirements. Note that it is fixed to ${PV} for kde-base packages.
DECLARATIVE_REQUIRED = "${DECLARATIVE_REQUIRED:-never}"
Is qtdeclarative required? Possible values are 'always', 'optional' and 'never'. This variable must be set before inheriting any eclasses. Defaults to 'never'.
QTHELP_REQUIRED = "${QTHELP_REQUIRED:-never}"
Is qthelp required? Possible values are 'always', 'optional' and 'never'. This variable must be set before inheriting any eclasses. Defaults to 'never'.
OPENGL_REQUIRED = "${OPENGL_REQUIRED:-never}"
Is qtopengl required? Possible values are 'always', 'optional' and 'never'. This variable must be set before inheriting any eclasses. Defaults to 'never'.
MULTIMEDIA_REQUIRED = "${MULTIMEDIA_REQUIRED:-never}"
Is qtmultimedia required? Possible values are 'always', 'optional' and 'never'. This variable must be set before inheriting any eclasses. Defaults to 'never'.
CPPUNIT_REQUIRED = "${CPPUNIT_REQUIRED:-never}"
Is cppunit required for tests? Possible values are 'always', 'optional' and 'never'. This variable must be set before inheriting any eclasses. Defaults to 'never'.
KDE_REQUIRED = "${KDE_REQUIRED:-always}"
Is kde required? Possible values are 'always', 'optional' and 'never'. This variable must be set before inheriting any eclasses. Defaults to 'always' If set to 'always' or 'optional', KDE_MINIMAL may be overriden as well. Note that for kde-base packages this variable is fixed to 'always'.
KDE_HANDBOOK = "${KDE_HANDBOOK:-never}"
Set to enable handbook in application. Possible values are 'always', 'optional' (handbook USE flag) and 'never'. This variable must be set before inheriting any eclasses. Defaults to 'never'. It adds default handbook dirs for kde-base packages to KMEXTRA and in any case it ensures buildtime and runtime dependencies.
KDE_LINGUAS_LIVE_OVERRIDE
Set this varible if you want your live package to manage its translations. (Mostly all kde ebuilds does not ship documentation and translations in live ebuilds)
QT_MINIMAL = "${QT_MINIMAL:-4.8.5}"
Determine version of qt we enforce as minimal for the package.
PREFIX
Set the installation PREFIX for non kde-base applications. It defaults to /usr. kde-base packages go into KDE4 installation directory (/usr). No matter the PREFIX, package will be built against KDE installed in /usr.
 

MAINTAINERS

kde@gentoo.org
 

REPORTING BUGS

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

FILES

/usr/portage/eclass/kde4-base.eclass  

SEE ALSO

ebuild(5)
http://sources.gentoo.org/eclass/kde4-base.eclass?view=log


 

Index

NAME
DESCRIPTION
FUNCTIONS
ECLASS VARIABLES
MAINTAINERS
REPORTING BUGS
FILES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 03:25:16 GMT, July 26, 2014