Gentoo Development Guide

CHECK-REQS.ECLASS

Section: portage (5)
Updated: May 2013
Index Return to Main Contents

NAME

check-reqs.eclass - Provides a uniform way of handling ebuild which have very high build requirements

DESCRIPTION

This eclass provides a uniform way of handling ebuilds which have very high build requirements in terms of memory or disk space. It provides a function which should usually be called during pkg_setup().

The chosen action only happens when the system's resources are detected correctly and only if they are below the threshold specified by the package.

# need this much memory (does *not* check swap)
CHECKREQS_MEMORY="256M"

# need this much temporary build space
CHECKREQS_DISK_BUILD="2G"

# install will need this much space in /usr
CHECKREQS_DISK_USR="1G"

# install will need this much space in /var
CHECKREQS_DISK_VAR="1024M"

If you don't specify a value for, say, CHECKREQS_MEMORY, then the test is not carried out.

These checks should probably mostly work on non-Linux, and they should probably degrade gracefully if they don't. Probably.

FUNCTIONS

check_reqs: Obsolete function executing all the checks and priting out results
check-reqs_pkg_setup: Exported function running the resources checks in pkg_setup phase. It should be run in both phases to ensure condition changes between pkg_pretend and pkg_setup won't affect the build.
check-reqs_pkg_pretend: Exported function running the resources checks in pkg_pretend phase.
check-reqs_prepare: Internal function that checks the variables that should be defined.
check-reqs_run: Internal function that runs the check based on variable settings.
check-reqs_get_mebibytes: Internal function that returns number in mebibytes. Converts from 1G=1024 or 1T=1048576
check-reqs_get_number: Internal function that returns number without the unit. Converts from 1G=1 or 150T=150.
check-reqs_get_unit: Internal function that returns number without the unit. Converts from 1G=1 or 150T=150.
check-reqs_output: Internal function that prints the warning and dies if required based on the test results.
check-reqs_memory: Internal function that checks size of RAM.
check-reqs_disk: Internal function that checks space on the harddrive.
check-reqs_start_phase: Internal function that inform about started check
check-reqs_unsatisfied: Internal function that inform about check result. It has different output between pretend and setup phase, where in pretend phase it is fatal.

ECLASS VARIABLES

CHECKREQS_MEMORY: How much RAM is needed? Eg.: CHECKREQS_MEMORY=15M
CHECKREQS_DISK_BUILD: How much diskspace is needed to build the package? Eg.: CHECKREQS_DISK_BUILD=2T
CHECKREQS_DISK_USR: How much space in /usr is needed to install the package? Eg.: CHECKREQS_DISK_USR=15G
CHECKREQS_DISK_VAR: How much space is needed in /var? Eg.: CHECKREQS_DISK_VAR=3000M

AUTHORS

Bo Ørsted Andresen <zlin@gentoo.org>
Original Author: Ciaran McCreesh <ciaranm@gentoo.org>

MAINTAINERS

QA Team <qa@gentoo.org>

REPORTING BUGS

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

FILES

/usr/portage/eclass/check-reqs.eclass

This document was created by man2html, using the manual pages.
Time: 03:25:02 GMT, May 22, 2013