[patch] confutils.eclass.patch

confutils.eclass.patch (text/plain), 9.23 KB, created by mren on 2008-02-20 23:21:01 UTC

--- confutils.eclass.orig	2008-02-20 23:43:09.000000000 +0100
+++ confutils.eclass	2008-02-21 00:17:27.000000000 +0100
@@ -1,36 +1,37 @@
-# Copyright 1999-2007 Gentoo Foundation
+# Copyright 1999-2008 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/confutils.eclass,v 1.20 2007/11/22 21:51:16 drac Exp $
-#
-# eclass/confutils.eclass
-#		Utility functions to help with configuring a package
-#
-#		Based on Stuart's work for the PHP 5 eclass
-#
-# Author(s)		Stuart Herbert
-#				<[e-mail]>
-#
-# ========================================================================
+# $Header: $
+
+# @ECLASS: confutils.eclass
+# @MAINTAINER:
+# ???
+# Author:
+# Stuart Herbert <[e-mail]>
+# @BLURB: Utility functions to help with configuring a package
+# @DESCRIPTION:
+# Utility functions to help with configuring a package
+# Based on Stuart's work for the PHP 5 eclass
 
 inherit eutils
 
+# @ECLASS-VARIABLE: EBUILD_SUPPORTS_SHAREDEXT
+# @DESCRIPTION:
+# If your ebuild supports sharedext set this var to 1
 if [[ ${EBUILD_SUPPORTS_SHAREDEXT} == 1 ]]; then
 	IUSE="sharedext"
 fi
 
-# ========================================================================
-
+# @ECLASS-VARIABLE: CONFUTILS_MISSING_DEPS
+# @DESCRIPTION:
 # list of USE flags that need deps that aren't yet in Portage
 # this list was originally added for PHP
 #
 # your eclass must define CONFUTILS_MISSING_DEPS if you need this
 
-# ========================================================================
-# confutils_init ()
-#
+# @FUNCTION: confutils_init
+# @DESCRIPTION:
 # Call this function from your src_compile() function to initialise
 # this eclass first
-
 confutils_init () {
 	if [[ ${EBUILD_SUPPORTS_SHAREDEXT} == 1 ]] && use sharedext ; then
 		shared="=shared"
@@ -39,17 +40,18 @@
 	fi
 }
 
-# ========================================================================
-# confutils_require_any ()
-#
+
+# @FUNCTION: confutils_require_any
+# @USAGE: < $1 > < $2 > < $3 >
+# @DESCRIPTION:
 # Use this function to ensure one or more of the specified USE flags have
 # been enabled
 #
+# @CODE
 # $1    - message to output everytime a flag is found
 # $2    - message to output everytime a flag is not found
 # $3 .. - flags to check
-#
-
+# @CODE
 confutils_require_any() {
 	success_msg="$1"
 	shift
@@ -86,15 +88,17 @@
 	die "Missing USE flags"
 }
 
-# ========================================================================
-# confutils_use_conflict ()
-#
+
+# @FUNCTION: confutils_use_conflict
+# @USAGE: < $1 > < $2 >
+# @DESCRIPTION:
 # Use this function to automatically complain to the user if conflicting
 # USE flags have been enabled
 #
-# $1	- flag that depends on other flags
+# @CODE
+# $1    - flag that depends on other flags
 # $2 .. - flags that conflict
-
+# @CODE
 confutils_use_conflict () {
 	if ! use $1 ; then
 		return
@@ -127,15 +131,16 @@
 	fi
 }
 
-# ========================================================================
-# confutils_use_depend_all ()
-#
+# @FUNCTION: confutils_use_depend_all
+# @USAGE: < $1 > < $2 >
+# @DESCRIPTION:
 # Use this function to automatically complain to the user if a USE flag
 # depends on another USE flag that hasn't been enabled
 #
-# $1	- flag that depends on other flags
+# @CODE
+# $1    - flag that depends on other flags
 # $2 .. - the flags that must be set for $1 to be valid
-
+# @CODE
 confutils_use_depend_all () {
 	if ! use $1 ; then
 		return
@@ -169,15 +174,16 @@
 	fi
 }
 
-# ========================================================================
-# confutils_use_depend_any ()
-#
+# @FUNCTION: confutils_use_depend_any
+# @USAGE: < $1 > < $2 >
+# @DESCRIPTION:
 # Use this function to automatically complain to the user if a USE flag
 # depends on another USE flag that hasn't been enabled
 #
-# $1	- flag that depends on other flags
+# @CODE
+# $1    - flag that depends on other flags
 # $2 .. - flags that must be set for $1 to be valid
-
+# @CODE
 confutils_use_depend_any () {
 	if ! use $1 ; then
 		return
@@ -209,17 +215,18 @@
 	fi
 }
 
-# ========================================================================
-# enable_extension_disable ()
-#
+# @FUNCTION: enable_extension_disable
+# @USAGE: < $1 > < $2 > [ $3 ]
+# @DESCRIPTION:
 # 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
 #
+# @CODE
 # $1	- extension name
 # $2	- USE flag
 # $3	- optional message to einfo() to the user
-
+# @CODE
 enable_extension_disable () {
 	if ! use "$2" ; then
 		my_conf="${my_conf} --disable-$1"
@@ -229,19 +236,20 @@
 	fi
 }
 
-# ========================================================================
-# enable_extension_enable ()
-#
+# @FUNCTION: enable_extension_enable
+# @USAGE: < $1 > < $2 > < $3 > < $4 > < $5 >
+# @DESCRIPTION:
 # 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
 #
+# @CODE
 # $1	- extension name
 # $2	- USE flag
 # $3	- 1 = support shared, 0 = never support shared
 # $4	- additional setting for configure
 # $5	- additional message to einfo out to the user
-
+# @CODE
 enable_extension_enable () {
 	local my_shared
 
@@ -269,19 +277,20 @@
 	fi
 }
 
-# ========================================================================
-# enable_extension_enableonly ()
-#
+# @FUNCTION: enable_extension_enableonly
+# @USAGE: < $1 > < $2 > < $3 > < $4 > < $5 >
+# @DESCRIPTION:
 # 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
 #
+# @CODEE
 # $1	- extension name
 # $2	- USE flag
 # $3	- 1 = support shared, 0 = never support shared
 # $4	- additional setting for configure
 # $5	- additional message to einfo out to the user
-
+# @CODE
 enable_extension_enableonly () {
 	local my_shared
 
@@ -308,17 +317,18 @@
 		einfo "  Disabling $1"
 	fi
 }
-# ========================================================================
-# enable_extension_without ()
-#
+# @FUNCTION: enable_extension_without
+# @USAGE: < $1 > < $2 > [ $3 ]
+# @DESCRIPTION:
 # 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
 #
+# @CODE
 # $1	- extension name
 # $2	- USE flag
 # $3	- optional message to einfo() to the user
-
+# @CODE
 enable_extension_without () {
 	if ! use "$2" ; then
 		my_conf="${my_conf} --without-$1"
@@ -328,18 +338,19 @@
 	fi
 }
 
-# ========================================================================
-# enable_extension_with ()
-#
+# @FUNCTION: enable_extension_with
+# @USAGE: < $1 > < $2 > < $3 > < $4 > [ $5 ]
+# @DESCRIPTION:
 # This function is a replacement for use_with.  It supports building
 # extensions as shared libraries,
-
+#
+# @CODE
 # $1	- extension name
 # $2	- USE flag
 # $3	- 1 = support shared, 0 = never support shared
 # $4	- additional setting for configure
 # $5	- optional message to einfo() out to the user
-
+# @CODE
 enable_extension_with () {
 	local my_shared
 
@@ -367,18 +378,19 @@
 	fi
 }
 
-# ========================================================================
-# enable_extension_withonly ()
-#
+# @FUNCTION: enable_extension_withonly
+# @USAGE: < $1 > < $2 > < $3 > < $4 > [ $5 ]
+# @DESCRIPTION:
 # This function is a replacement for use_with.  It supports building
 # extensions as shared libraries,
-
+#
+# @CODE
 # $1	- extension name
 # $2	- USE flag
 # $3	- 1 = support shared, 0 = never support shared
 # $4	- additional setting for configure
 # $5	- optional message to einfo() out to the user
-
+# @CODE
 enable_extension_withonly () {
 	local my_shared
 
@@ -406,8 +418,6 @@
 	fi
 }
 
-# ========================================================================
-# confutils_warn_about_external_deps
 
 confutils_warn_about_missing_deps ()
 {
@@ -431,19 +441,20 @@
 	fi
 }
 
-# ========================================================================
-# enable_extension_enable_built_with ()
-#
+# @FUNCTION: enable_extension_enable_built_with
+# @USAGE: < $1 > < $2 > < $3 > < $4 > < $5 >
+# @DESCRIPTION:
 # 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
 #
-# $1    - pkg name
+# @CODE
+# $1	- pkg name
 # $2	- USE flag
 # $3	- extension name
 # $4	- additional setting for configure
 # $5	- alternative message
-
+# @CODE
 enable_extension_enable_built_with () {
 	local msg=$3
 	[[ -n $5 ]] && msg="$5"
@@ -460,19 +471,20 @@
 	fi
 }
 
-# ========================================================================
-# enable_extension_with_built_with ()
-#
+# @FUNCTION: enable_extension_with_built_with
+# @USAGE: < $1 > < $2 > < $3 > < $4 > < $5 >
+# @DESCRIPTION:
 # 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
 #
-# $1    - pkg name
+# @CODE
+# $1	- pkg name
 # $2	- USE flag
 # $3	- extension name
 # $4	- additional setting for configure
 # $5	- alternative message
-
+# @CODE
 enable_extension_with_built_with () {
 	local msg=$3
 	[[ -n $5 ]] && msg="$5"