NINJA-UTILS.ECLASS

Section: eclass-manpages (5)
Updated: Nov 2022
Index Return to Main Contents

NAME

ninja-utils.eclass - common bits to run dev-util/ninja builder

DESCRIPTION

This eclass provides a single function -- eninja -- that can be used to run the ninja builder alike emake. It does not define any dependencies, you need to depend on dev-util/ninja yourself. Since ninja is rarely used stand-alone, most of the time this eclass will be used indirectly by the eclasses for other build systems (CMake, Meson).

SUPPORTED EAPIS

5 6 7 8

FUNCTIONS

get_NINJAOPTS: Get the value of NINJAOPTS, inferring them from MAKEOPTS if unset.
eninja [<args>...]: Call Ninja, passing the NINJAOPTS (or converted MAKEOPTS), followed by the supplied arguments. This function dies if ninja fails. Starting with EAPI 6, it also supports being called via 'nonfatal'.

ECLASS VARIABLES

NINJA ?= ninja (SET BEFORE INHERIT): Specify a compatible ninja implementation to be used by eninja(). At this point only "ninja" and "samu" are explicitly supported, but other values can be set where NINJA_DEPEND will then be set to a blank variable. The default is set to "ninja".
NINJA_DEPEND (GENERATED BY ECLASS): Contains a set of build-time depenendencies based on the NINJA setting.
NINJAOPTS: The default set of options to pass to Ninja. Similar to MAKEOPTS, supposed to be set in make.conf. If unset, eninja() will convert MAKEOPTS instead.

AUTHORS

Michał Górny <mgorny@gentoo.org>
Mike Gilbert <floppym@gentoo.org>

MAINTAINERS

Michał Górny <mgorny@gentoo.org>
Mike Gilbert <floppym@gentoo.org>

REPORTING BUGS

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

FILES

ninja-utils.eclass

This document was created by man2html, using the manual pages.
Time: 03:27:02 GMT, November 30, 2022