mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-06-08 02:38:11 +09:00
00b1aef96b
Motivation for this hook is simple: there's no single documented way to do trivial things with ctest: 1. Pass additional flags to ctest invocation. 2. Selectively disable tests in a mechanism similar to python's `disabledTests` or rust's composable skips in `checkFlags`. 3. Disable parallel checking. Current state of things has lead to several different solutions: 1. Completely overriding `checkPhase` [1] and invoking ctest manually with the necessary flags. This is most often coupled with `-E` for disabling test or setting parallel level. 2. Wrangling with weird double string/regex escaping and trying to stuff additional parameters and/or exclusion regex via `CMAKE_CTEST_ARGUMENTS`. This approach is especially painful when test names have spaces. This is the reason I originally decided to implement this hook after wrangling with failing darwin tests here [2]. 3. Stuffing additional arguments into `checkFlagsArray` with the `ARGS` makefile parameter [3]. I don't see any reason to keep the status-quo. Doing something along these lines has been suggested [4] for both `ctest` and `meson`. Meson setup-hook has switched from `ninja` to `meson` in [5] with little friction. Doing the same for cmake in a single sweep would prove problematic due to the aforementioned zoo of workarounds and hacks for `ctest`. Doing it via a separate hook would allow us to refactor things piecemeal and without going through staging. The benefit of the hook is immediately clear and it would allow to drive the refactor tractor at a comfortable pace. [1]: pd/pdal/package.nix:117, cc/ccache/package.nix:108, gl/glog/package.nix:79 [2]: https://www.github.com/NixOS/nixpkgs/pull/375955 [3]: op/open62541/package.nix:114 [4]: https://www.github.com/NixOS/nixpkgs/issues/113829 [5]: https://www.github.com/NixOS/nixpkgs/pull/213845
53 lines
2.3 KiB
Markdown
53 lines
2.3 KiB
Markdown
# cmake {#cmake}
|
||
|
||
Overrides the default configure phase to run the CMake command.
|
||
|
||
By default, we use the Make generator of CMake.
|
||
But when Ninja is also available as a `nativeBuildInput`, this setup hook will detect that and use the ninja generator.
|
||
|
||
Dependencies are added automatically to `CMAKE_PREFIX_PATH` so that packages are correctly detected by CMake.
|
||
Some additional flags are passed in to give similar behavior to configure-based packages.
|
||
|
||
By default, parallel building is enabled as CMake supports parallel building almost everywhere.
|
||
|
||
You can disable this hook’s behavior by setting `configurePhase` to a custom value, or by setting `dontUseCmakeConfigure`.
|
||
|
||
## Variables controlling CMake {#cmake-variables-controlling}
|
||
|
||
### CMake Exclusive Variables {#cmake-exclusive-variables}
|
||
|
||
#### `cmakeFlags` {#cmake-flags}
|
||
|
||
Controls the flags passed to `cmake setup` during configure phase.
|
||
|
||
#### `cmakeBuildDir` {#cmake-build-dir}
|
||
|
||
Directory where CMake will put intermediate files.
|
||
|
||
Setting this can be useful for debugging multiple CMake builds while in the same source directory, for example, when building for different platforms.
|
||
Different values for each build will prevent build artefacts from interefering with each other.
|
||
This setting has no tangible effect when running the build in a sandboxed derivation.
|
||
|
||
The default value is `build`.
|
||
|
||
#### `dontUseCmakeConfigure` {#dont-use-cmake-configure}
|
||
|
||
When set to true, don't use the predefined `cmakeConfigurePhase`.
|
||
|
||
## Controlling CTest invocation {#cmake-ctest}
|
||
|
||
By default tests are run by make in [`checkPhase`](#ssec-check-phase) or by [ninja](#ninja) if `ninja` is
|
||
available in `nativeBuildInputs`. Makefile and Ninja generators produce the `test` target, which invokes `ctest` under the hood.
|
||
This makes passing additional arguments to `ctest` difficult, so it's possible to invoke it directly in `checkPhase`
|
||
by adding `ctestCheckHook` to `nativeCheckInputs`.
|
||
|
||
### CTest Variables {#cmake-ctest-variables}
|
||
|
||
#### `disabledTests` {#cmake-ctest-disabled-tests}
|
||
|
||
Allows to disable running a list of tests. Note that regular expressions are not supported by `disabledTests`, but
|
||
it can be combined with `--exclude-regex` option.
|
||
|
||
#### `ctestFlags` {#cmake-ctest-flags}
|
||
|
||
Additional options passed to `ctest` together with `checkFlags`.
|