CMAKE.ECLASS

Section: eclass-manpages (5)
Updated: Jul 2025
Index Return to Main Contents

NAME

cmake.eclass - common ebuild functions for cmake-based packages

DESCRIPTION

The cmake eclass makes creating ebuilds for cmake-based packages much easier. It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source builds (default) and in-source builds.

SUPPORTED EAPIS

7 8

TRANSITIVELY PROVIDED ECLASSES

ninja-utils

FUNCTIONS

cmake_run_in <working dir> <run command>: Set the desired working dir for a function or command.
cmake_comment_add_subdirectory <subdirectory>: Comment out one or more add_subdirectory calls in CMakeLists.txt in the current directory
cmake_use_find_package <USE flag> <package name>: Based on use_enable. See ebuild(5).
`cmake_use_find_package foo LibFoo` echoes -DCMAKE_DISABLE_FIND_PACKAGE_LibFoo=OFF if foo is enabled and -DCMAKE_DISABLE_FIND_PACKAGE_LibFoo=ON if it is disabled. This can be used to make find_package optional.
cmake_src_prepare: Apply ebuild and user patches. *MUST* be run or cmake_src_configure will fail.
MYCMAKEARGS: User-controlled environment variable containing arguments to be passed to cmake in cmake_src_configure.
cmake_src_configure: General function for configuring with cmake. Default behaviour is to start an out-of-source build. Passes arguments to cmake by reading from an optionally pre-defined local mycmakeargs bash array. src_configure() {         local mycmakeargs=(
                $(cmake_use_find_package foo LibFoo)
        )
        cmake_src_configure
}
cmake_src_compile: General function for compiling with cmake. All arguments are passed to cmake_build.
cmake_build: Function for building the package. Automatically detects the build type. All arguments are passed to eninja (default) or emake depending on the value of CMAKE_MAKEFILE_GENERATOR.
cmake_src_test: Function for testing the package. Automatically detects the build type.
cmake_src_install: Function for installing the package. Automatically detects the build type.

ECLASS VARIABLES

BUILD_DIR

Build directory where all cmake processed files should be generated. For in-source build it's fixed to ${CMAKE_USE_DIR}. For out-of-source build it can be overridden, by default it uses ${CMAKE_USE_DIR}_build (in EAPI-7: ${WORKDIR}/${P}_build).

CMAKE_BINARY ?= cmake

Eclass can use different cmake binary than the one provided in by system.

CMAKE_BUILD_TYPE ?= RelWithDebInfo

Set to override default CMAKE_BUILD_TYPE. Only useful for packages known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)". If about to be set - needs to be set before invoking cmake_src_configure.

The default is RelWithDebInfo as that is least likely to append undesirable flags. However, you may still need to sed CMake files or choose a different build type to achieve desirable results.

In EAPI 7, the default was non-standard build type of Gentoo.

CMAKE_IN_SOURCE_BUILD

Set to enable in-source build.

CMAKE_MAKEFILE_GENERATOR ?= ninja (SET BEFORE INHERIT)

Specify a makefile generator to be used by cmake. At this point only "emake" and "ninja" are supported. The default is set to "ninja".

CMAKE_REMOVE_MODULES_LIST (SET BEFORE INHERIT)

Array of .cmake modules to be removed in ${CMAKE_USE_DIR} (in EAPI-7: ${S}) during src_prepare, in order to force packages to use the system version. By default, contains "FindBLAS" and "FindLAPACK". Set to empty to disable removing modules entirely.

CMAKE_USE_DIR

Sets the directory where we are working with cmake, for example when application uses autotools and only one plugin needs to be done by cmake. By default it uses current working directory (in EAPI-7: ${S}).

CMAKE_VERBOSE ?= ON (USER VARIABLE)

Set to OFF to disable verbose messages during compilation

CMAKE_WARN_UNUSED_CLI ?= yes

Warn about variables that are declared on the command line but not used. Might give false-positives. "no" to disable (default) or anything else to enable.

CMAKE_EXTRA_CACHE_FILE (USER VARIABLE)

Specifies an extra cache file to pass to cmake. This is the analog of EXTRA_ECONF for econf and is needed to pass TRY_RUN results when cross-compiling. Should be set by user in a per-package basis in /etc/portage/package.env.

CMAKE_QA_COMPAT_SKIP

If set, skip detection of CMakeLists.txt unsupported in CMake 4 in case of false positives (e.g. unused outdated bundled libs).

_CMAKE_MINREQVER_UNSUPPORTED

Internal status set by _cmake_minreqver-lt(); is true if an unsupported cmake_minimum_required value was detected.

CMAKE_QA_SRC_DIR_READONLY (USER VARIABLE)

After running cmake_src_prepare, sets ${CMAKE_USE_DIR} (in EAPI-7: ${S}) to read-only. This is a user flag and should under _no circumstances_ be set in the ebuild. Helps in improving QA of build systems that write to source tree.

CMAKE_SKIP_TESTS

Array of tests that should be skipped when running CTest.

CTEST_JOBS (USER VARIABLE)

Maximum number of CTest jobs to run in parallel. If unset, the value will be determined from make options.

CTEST_LOADAVG (USER VARIABLE)

Maximum load, over which no new jobs will be started by CTest. Note that unlike make, CTest will not start *any* jobs if the load is exceeded. If unset, the value will be determined from make options.

AUTHORS

Tomáš Chvátal <scarabeus@gentoo.org>
Maciej Mrozowski <reavertm@gentoo.org>
(undisclosed contributors)
Original author: Zephyrus (zephyrus@mirach.it)

MAINTAINERS

kde@gentoo.org
base-system@gentoo.org

REPORTING BUGS

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

FILES

cmake.eclass

This document was created by man2html, using the manual pages.
Time: 03:27:01 GMT, July 12, 2025