Improve documentation on multilib_is_native_abi & multilib_build_binaries to make it clear which one to use. Requested and reviewed by okias.

2 files changed, 14 insertions, 11 deletions

diff --git a/eclass/ChangeLog b/eclass/ChangeLog
index 9b1a026587b6..8d5f718aa8d1 100644
--- a/eclass/ChangeLog
+++ b/eclass/ChangeLog
@@ -1,6 +1,10 @@
 # ChangeLog for eclass directory
 # Copyright 1999-2013 Gentoo Foundation; Distributed under the GPL v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/ChangeLog,v 1.1104 2013/12/30 08:25:35 dirtyepic Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/ChangeLog,v 1.1105 2013/12/31 18:31:47 mgorny Exp $
+
+  31 Dec 2013; Michał Górny <mgorny@gentoo.org> multilib-build.eclass:
+  Improve documentation on multilib_is_native_abi & multilib_build_binaries to
+  make it clear which one to use. Requested and reviewed by okias.
 
   30 Dec 2013; Ryan Hill <dirtyepic@gentoo.org> wxwidgets.eclass:
   Add 3.0 support.
diff --git a/eclass/multilib-build.eclass b/eclass/multilib-build.eclass
index a93e5b90a466..9323df1f39de 100644
--- a/eclass/multilib-build.eclass
+++ b/eclass/multilib-build.eclass
@@ -1,6 +1,6 @@
 # Copyright 1999-2013 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/multilib-build.eclass,v 1.24 2013/12/28 18:23:25 jlec Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/multilib-build.eclass,v 1.25 2013/12/31 18:31:47 mgorny Exp $
 
 # @ECLASS: multilib-build.eclass
 # @MAINTAINER:
@@ -371,9 +371,8 @@ multilib_install_wrappers() {
 # Determine whether the currently built ABI is the profile native.
 # Return true status (0) if that is true, otherwise false (1).
 #
-# This is often useful for configure calls when some of the options are
-# supposed to be disabled for multilib ABIs (like those used for
-# executables only).
+# This function is not intended to be used directly. Please use
+# multilib_build_binaries instead.
 multilib_is_native_abi() {
 	debug-print-function ${FUNCNAME} "${@}"
 
@@ -384,14 +383,14 @@ multilib_is_native_abi() {
 
 # @FUNCTION: multilib_build_binaries
 # @DESCRIPTION:
-# Determine whether to build binaries for the current build ABI.
-# Returns true status (0) if the current built ABI is the profile
-# native or COMPLETE_MULTILIB variable is set to yes, otherwise
+# Determine whether to build binaries for the currently build ABI.
+# Returns true status (0) if the currently built ABI is the profile
+# native or COMPLETE_MULTILIB variable is set to 'yes', otherwise
 # false (1).
 #
-# The COMPLETE_MULTILIB variable can be set by users or profiles
-# when they want to build binaries for none-default ABI so e.g.
-# 32bit binaries on amd64.
+# This is often useful for configure calls when some of the options are
+# supposed to be disabled for multilib ABIs (like those used for
+# executables only).
 multilib_build_binaries() {
 	debug-print-function ${FUNCNAME} "${@}"