Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

CMakeGenerateParams

The CMakeGenerate parameter type.

Record Fields

Record FieldDescription
AdditionalArgs
Signature: string

A character string containing additional arguments to give to CMake.

BinaryDirectory
Signature: string

The binary build directory where CMake will generate the files.

CacheEntriesToRemove
Signature: string list

Remove matching entries from CMake cache. Equivalent to the -U <globbing_expr> options.

Caches
Signature: string list

A list of the optional CMake cache files to load. Equivalent to the -C <initial-cache> options.

Generator
Signature: string

The native build system generator to use for writing the files. See cmake --help for a list of the available entries. To avoid unpredictable generator usage, it is recommended to define it. Equivalent to the -G <generator-name> option.

InstallDirectory
Signature: string

The directory where CMake will install the generated files. Equivalent to the -D CMAKE_INSTALL_PREFIX:DIRPATH="<install-directory>" CMake option.

Platform
Signature: string

An optional CMake platform. Equivalent to the -A <platform-name> option. Not supported by every generator.

SourceDirectory
Signature: string

The source directory which should include a CMakeLists.txt file.

Timeout
Signature: TimeSpan

The CMake execution timeout.

Toolchain
Signature: string

An optional toolchain file to load. Equivalent to the -D CMAKE_TOOLCHAIN_FILE:FILEPATH="<toolchain-file>" CMake option.

ToolPath
Signature: string

The location of the CMake executable. Automatically found if null or empty.

Toolset
Signature: string

An optional toolset (!= toolchain) to use. Equivalent to the -T <toolset-name> option. Not supported by every generator.

Variables
Signature: CMakeVariable list

A list of every variable to pass as a CMake argument. Equivalent to the -D <var>:<type>=<value> options.