[gentoo-dev] [PATCH] [committed] edo.eclass: update eclassdoc to clarify purpose

[Sam James]

Signed-off-by: Sam James <sam@g.o>
---
 eclass/edo.eclass | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/eclass/edo.eclass b/eclass/edo.eclass
index 550d6770cb63..c2e7ed60083f 100644
--- a/eclass/edo.eclass
+++ b/eclass/edo.eclass
@@ -10,9 +10,12 @@
 # @BLURB: Convenience function to run commands verbosely and die on failure
 # @DESCRIPTION:
 # This eclass provides the 'edo' command, and an 'edob' variant for ebegin/eend,
-# which dies (exits) on failure and logs the command used verbosely.
+# which logs the command used verbosely and dies (exits) on failure.
 #
-
+# This eclass should be used only where needed to give a more verbose log, e.g.
+# for invoking non-standard ./configure scripts, or building objects/binaries
+# directly within ebuilds via compiler invocations. It is NOT to be used
+# in place of generic 'command || die' where verbosity is unnecessary.
 case ${EAPI} in
 	7|8) ;;
 	*) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
-- 
2.35.1