diff options
| author |   Sam James <sam@gentoo.org> | 2022-04-18 18:58:13 +0100 |
|---|---|---|
| committer | Sam James <sam@gentoo.org> | 2022-04-18 18:58:42 +0100 |
| commit | 6ce8bc59bc81e8a509570c7364e7177bdc181b16 (patch) | |
| tree | f54ab8f395cc59abe2eaf48b53bab2724fb32da6 /eclass/edo.eclass | |
| parent | net-analyzer/netdata: 1.34.1 version bump (diff) | |
| download | gentoo-6ce8bc59bc81e8a509570c7364e7177bdc181b16.tar.gz gentoo-6ce8bc59bc81e8a509570c7364e7177bdc181b16.tar.bz2 gentoo-6ce8bc59bc81e8a509570c7364e7177bdc181b16.zip | |
edo.eclass: update eclassdoc to clarify purpose
Signed-off-by: Sam James <sam@gentoo.org>
Diffstat (limited to 'eclass/edo.eclass')
| -rw-r--r-- | eclass/edo.eclass | 7 |
1 files 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" ;; |