[gentoo-commits] proj/sci:master commit in: eclass/

[Justin Lecher]

commit:     fb6a9afe1a59aa13302044fe68f3c391d4368cee
Author:     Justin Lecher <jlec <AT> gentoo <DOT> org>
AuthorDate: Fri Nov 23 18:48:37 2012 +0000
Commit:     Justin Lecher <jlec <AT> gentoo <DOT> org>
CommitDate: Tue Nov 27 19:21:56 2012 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/sci.git;a=commit;h=fb6a9afe

Add descriptions to standard phase functions.

---
 eclass/intel-sdp.eclass |   24 ++++++++++++++++++++++++
 1 files changed, 24 insertions(+), 0 deletions(-)

diff --git a/eclass/intel-sdp.eclass b/eclass/intel-sdp.eclass
index b982601..14dba83 100644
--- a/eclass/intel-sdp.eclass
+++ b/eclass/intel-sdp.eclass
@@ -133,6 +133,14 @@ intel-sdp_pkg_pretend() {
 #
 # e.g. amd64-multilib -> INTEL_ARCH="intel64 ia32"
 
+# @ ECLASS-FUNCTION: intel-sdp_pkg_setup
+# @DESCRIPTION:
+# The setup finction serves two purposes:
+#
+# * Check that the user has a (valid) license file before going on.
+#
+# * Setting up and sorting some internal variables
+
 intel-sdp_pkg_setup() {
 	local _warn=1 _dirs i _ret arch a p
 	_dirs=(
@@ -177,6 +185,10 @@ intel-sdp_pkg_setup() {
 	esac
 }
 
+# @ ECLASS-FUNCTION: intel-sdp_src_unpack
+# @DESCRIPTION:
+# Unpacking necessary rpms from tarball, extract them and rearrange the output.
+
 intel-sdp_src_unpack() {
 	local l r t rpmdir
 	debug-print "INTEL_RPMS_DIRS are \"${INTEL_RPMS_DIRS}\""
@@ -224,6 +236,10 @@ intel_link_eclipse_plugins() {
 	popd > /dev/null
 }
 
+# @ ECLASS-FUNCTION: intel-sdp_src_install
+# @DESCRIPTION:
+# Install everything
+
 intel-sdp_src_install() {
 	if ! use doc && [[ -d "${INTEL_SDP_DIR}"/Documentation ]]; then
 		ebegin "Cleaning out documentation"
@@ -419,6 +435,10 @@ run-test() {
 # Full path to intel registry db
 INTEL_SDP_DB="${EROOT%/}"/opt/intel/intel-sdp-products.db
 
+# @ECLASS-FUNCTION
+# @DESCRIPTION:
+# Add things to intel database
+
 intel-sdp_pkg_postinst() {
 	# add product registry to intel "database"
 	local l r
@@ -430,6 +450,10 @@ intel-sdp_pkg_postinst() {
 	run-test
 }
 
+# @ECLASS-FUNCTION
+# @DESCRIPTION:
+# Sanitize intel database
+
 intel-sdp_pkg_postrm() {
 	# remove from intel "database"
 	if [[ -e ${INTEL_SDP_DB} ]]; then