CONFUTILS.ECLASS

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

---

 

NAME

confutils.eclass - utility functions to help with configuring a package  

DESCRIPTION

The confutils eclass contains functions to handle use flag dependencies and extended --with-*/--enable-* magic.

Based on the PHP5 eclass by Stuart Herbert <stuart@stuartherbert.com>  

FUNCTIONS

EBUILD_SUPPORTS_SHAREDEXT

Set this variable to 1 if your ebuild supports shared extensions. You need to call confutils_init() in pkg_setup() if you use this variable.

confutils_init [value]

Call this function from your pkg_setup() function to initialize this eclass if EBUILD_SUPPORTS_SHAREDEXT is enabled. If no value is given `shared' is used by default.

confutils_require_one <flag> [more flags ...]

Use this function to ensure exactly one of the specified USE flags have been enabled

confutils_require_any <flag> [more flags ...]

Use this function to ensure one or more of the specified USE flags have been enabled

confutils_require_built_with_all <foreign> <flag> [more flags ...]

Use this function to ensure all of the specified USE flags have been enabled in the specified foreign package

confutils_require_built_with_any <foreign> <flag> [more flags ...]

Use this function to ensure one or more of the specified USE flags have been enabled in the specified foreign package

confutils_use_conflict <enabled flag> <conflicting flag> [more conflicting flags ...]

Use this function to automatically complain to the user if conflicting USE flags have been enabled

confutils_use_depend_all <enabled flag> <needed flag> [more needed flags ...]

Use this function to automatically complain to the user if a USE flag depends on another USE flag that hasn't been enabled

confutils_use_depend_any <enabled flag> <needed flag> [more needed flags ...]

Use this function to automatically complain to the user if a USE flag depends on another USE flag that hasn't been enabled

confutils_use_depend_built_with_all <enabled flag> <foreign> <needed flag> [more needed flags ...]

Use this function to automatically complain to the user if a USE flag depends on a USE flag in another package that hasn't been enabled

confutils_use_depend_built_with_any <enabled flag> <foreign> <needed flag> [more needed flags ...]

Use this function to automatically complain to the user if a USE flag depends on a USE flag in another package that hasn't been enabled

enable_extension_disable <extension> <flag> [msg]

Use this function to disable an extension that is enabled by default. This is provided for those rare configure scripts that don't support a --enable for the corresponding --disable.

enable_extension_enable <extension> <flag> [shared] [extra conf] [msg]

This function is like use_enable(), except that it knows about enabling modules as shared libraries, and it supports passing additional data with the switch.

enable_extension_enableonly <extension> <flag> [shared] [extra conf] [msg]

This function is like use_enable(), except that it knows about enabling modules as shared libraries, and it supports passing additional data with the switch. This function is provided for those rare configure scripts that support --enable but not the corresponding --disable.

enable_extension_without <extension> <flag> [msg]

Use this function to disable an extension that is enabled by default. This function is provided for those rare configure scripts that support --without but not the corresponding --with

enable_extension_with <extension> <flag> [shared] [extra conf] [msg]

This function is like use_with(), except that it knows about enabling modules as shared libraries, and it supports passing additional data with the switch.

enable_extension_withonly <extension> <flag> [shared] [extra conf] [msg]

This function is like use_with(), except that it knows about enabling modules as shared libraries, and it supports passing additional data with the switch. This function is provided for those rare configure scripts that support --enable but not the corresponding --disable.

enable_extension_enable_built_with <foreign> <flag> <extension> [shared] [extra conf] [msg]

This function is like enable_extension_enable(), except that it enables/disables modules based on a USE flag in a foreign package.

enable_extension_with_built_with <foreign> <flag> <extension> [shared] [extra conf] [msg]

This function is like enable_extension_with(), except that it enables/disables modules based on a USE flag in a foreign package.

 

MAINTAINERS

Benedikt Böhm <hollow@gentoo.org>

 

REPORTING BUGS

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

FILES

/usr/portage/eclass/confutils.eclass  

SEE ALSO

ebuild(5)

http://sources.gentoo.org/eclass/confutils.eclass?view=log

---

 

Index

NAME

DESCRIPTION

FUNCTIONS

MAINTAINERS

REPORTING BUGS

FILES

SEE ALSO

---

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