Functions
BasisBootstrapping.cmake File Reference

Auxiliary function to bootstrap the build of CMake BASIS. More...

#include "CMakeParseArguments.cmake"
+ Include dependency graph for BasisBootstrapping.cmake:

Go to the source code of this file.

Functions

function basis_bootstrap (in ARGN)
 Boostrap build of CMake BASIS during configuration of project. More...
 

Detailed Description

Auxiliary function to bootstrap the build of CMake BASIS.

Definition in file BasisBootstrapping.cmake.

Function Documentation

§ basis_bootstrap()

function basis_bootstrap ( in  ARGN)

Boostrap build of CMake BASIS during configuration of project.

This function downloads, configures, and builds CMake BASIS. If the (cached) variable BASIS_INSTALL_PREFIX is set, it also installs BASIS into the specified directory. This is only required if the project uses the BASIS Utilities. Otherwise, the BASIS build tree can be used directly to build the software project which bootstrapped BASIS. It is not required during runtime of the software.

Parameters
[in]ARGNThe list of arguments is parsed as follows:
VERSION major.minor.patch Version of CMake BASIS to download.
DOWNLOAD_URL url URL from which to download the CMake BASIS source distribution package. The given URL can be either a complete download URL which includes the package name (which must end with .tar.gz or .zip) or the path of a remote directory which contains the CMake BASIS packages named cmake-basis-version.zip (for Windows) and cmake-basis-version.tar.gz (for Unix). (default: http://opensource.andreasschuh.com/cmake-basis/_downloads)
INFORM_USER This option causes this function to abort the initial configure step of CMake. It informs the user that this project required BASIS for the build configuration and that it upon the next configure run it will attempt to download and build BASIS automatically. It further notes that the user can set the BASIS_DIR variable prior to the next configure run in order to use an existing BASIS installation. (default: off)
BASIS_VARIABLE_NAME value Adds a build configuration to the CMake command used to configure the build of CMake BASIS using the -D option of cmake. The BASIS_VARIABLE_NAME can be any CMake option or variable that is normally used to configure a BASIS build using CMake. For example, USE_PythonInterp, USE_BASH, USE_DOXYGEN.
Returns
Sets the BASIS_DIR variable to the bootstrapped BASIS build.