EDO.ECLASS

Section: eclass-manpages (5)
Updated: Oct 2024
Index Return to Main Contents

NAME

edo.eclass - 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 logs the command used verbosely and dies (exits) on failure.

The 'edo' command 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.

The 'edob' command can be used for long running commands, even if those commands produce output. The 'edob' command will suppress the command's output and only present it if the command returned with a non-zero exit status.

SUPPORTED EAPIS

7 8

FUNCTIONS

edo <command> [<args>...]: Executes a short 'command' with any given arguments and exits on failure unless called under 'nonfatal'.
edob [-l <log-name>] [-m <message>] <command> [<args>...]: Executes 'command' with ebegin & eend with any given arguments and exits on failure unless called under 'nonfatal'. This function redirects stdout and stderr to a log file. The content of the log file is shown if the command returns with a non-zero exit status.
If -m <message> is provided, then invokes ebegin with <message>, otherwise a default message is used. If -l <log-name> is provided, then <log-name> is used to construct the name of the log file where stdout and stderr of the command is redirected to.

AUTHORS

Sam James <sam@gentoo.org>

MAINTAINERS

QA Team <qa@gentoo.org>

REPORTING BUGS

Please report bugs via https://bugs.gentoo.org/

FILES

edo.eclass

This document was created by man2html, using the manual pages.
Time: 03:27:01 GMT, October 07, 2024