Variables
BasisSettings.cmake File Reference

Default project-independent settings. More...

#include "/CommonTools.cmake"
+ Include dependency graph for BasisSettings.cmake:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Variables

cmake __BASIS_SETTINGS_INCLUDED
 
cmake BASIS_ALL_DOC
 Advanced non-cached variable to request build of documentation targets as part of ALL target. More...
 
cmake BASIS_BASH_LIBRARY_TARGET
 Name of library target which builds Bash modules in PROJECT_LIBRARY_DIR. More...
 
option BASIS_BUILD_ONLY = OFF
 Request configuration of software build only, skipping steps related to packaging and installation. More...
 
option BASIS_COMPILE_SCRIPTS = OFF
 Enable compilation of scripts if supported by the language. More...
 
cmake BASIS_CONFIGURE_PUBLIC_HEADERS
 Whether BASIS should configure any public header file with the .in file name suffix. More...
 
option BASIS_DEBUG = OFF
 Request debugging messages from BASIS functions. More...
 
cmake BASIS_DOXYGEN_DOXYFILE
 Default Doxygen configuration. More...
 
cmake BASIS_EXPORT_DEFAULT
 Whether to export targets by default. More...
 
cmake BASIS_EXPORT_ENABLED
 Whether to create "<Package><ExportSuffix>.cmake" file so other projects can import the exported targets. More...
 
cmake BASIS_EXPORT_SUFFIX
 Suffix used for target exports file "<Package><ExportSuffix>.cmake". More...
 
cmake BASIS_GE_CONFIG
 Name of build configuration ("$<CONFIG>") generator expression. More...
 
cmake BASIS_IMPORT_TARGETS
 Enable/disable import of targets using the BASIS ImportTools. More...
 
cmake BASIS_INSTALL_PUBLIC_HEADERS_OF_CXX_UTILITIES
 Force installation of public header files of BASIS C++ utilities. More...
 
option BASIS_INSTALL_SITE_PACKAGES = OFF
 Enable the installation of scripted modules in site specific default directories. More...
 
cmake BASIS_JYTHON_LIBRARY_TARGET
 Name of library target which builds Jython modules in PROJECT_LIBRARY_DIR. More...
 
cmake BASIS_LANGUAGES
 List of programming languages explicitly supported by BASIS. More...
 
cmake BASIS_LIBRARY_COMPONENT
 Default component used for library targets when no component is specified. More...
 
cmake BASIS_MATLAB_LIBRARY_TARGET
 Name of library target which builds MATLAB modules in PROJECT_LIBRARY_DIR. More...
 
 BASIS_METADATA_LIST_SWITCH
 Names of project meta-data switches. More...
 
cmake BASIS_NAMESPACE_DELIMITER_BASH
 Namespace delimiter used in Bash. More...
 
cmake BASIS_NAMESPACE_DELIMITER_CMAKE
 Namespace delimiter used in CMake. More...
 
cmake BASIS_NAMESPACE_DELIMITER_CXX
 Namespace delimiter used in C++. More...
 
cmake BASIS_NAMESPACE_DELIMITER_JYTHON
 Namespace delimiter used in Jython. More...
 
cmake BASIS_NAMESPACE_DELIMITER_MATLAB
 Namespace delimiter used in MATLAB. More...
 
cmake BASIS_NAMESPACE_DELIMITER_PERL
 Namespace delimiter used in Perl. More...
 
cmake BASIS_NAMESPACE_DELIMITER_PYTHON
 Namespace delimiter used in Python. More...
 
cmake BASIS_PERL_LIBRARY_TARGET
 Name of library target which builds Perl modules in PROJECT_LIBRARY_DIR. More...
 
cmake BASIS_PYTHON_LIBRARY_TARGET
 Name of library target which builds Python modules in PROJECT_LIBRARY_DIR. More...
 
option BASIS_REGISTER = ON
 Enable/disable registration of installed package in CMake registry. More...
 
option BASIS_REVISION_INFO = ON
 Disable use of the revision information obtained from the revision control software such as Subversion or Git. More...
 
cmake BASIS_RUNTIME_COMPONENT
 Default component used for executables when no component is specified. More...
 
cmake BASIS_SCRIPT_EXECUTE_PROCESS
 Script used to execute a process in CMake script mode. More...
 
cmake BASIS_SPHINX_CONFIG
 Default Sphinx configuration. More...
 
cmake BASIS_SPHINX_HTML_THEME
 Default Sphinx theme. More...
 
option BASIS_SUPERBUILD_MODULES = OFF
 EXPERIMENTAL - Build project modules as separate external projects. More...
 
cmake BASIS_SUPPORT_SLICER_MODULES
 Whether basis_project_begin() should support the configuration of Slicer modules. More...
 
cmake BASIS_SVN_USERS_FILE
 File used by default as –authors file to svn2cl. More...
 
cmake BASIS_USE_FULLY_QUALIFIED_UIDS
 Whether BASIS shall use fully-qualified target UIDs. More...
 
cmake BASIS_UTILITIES
 Enable the automatic detection of the use of the BASIS utilities. More...
 
option BASIS_VERBOSE = OFF
 Default Sphinx theme options. More...
 
option BUILD_BASIS_UTILITIES_FOR_BASH = OFF
 Whether to always build the BASIS Bash utilities even if not required by any target. More...
 
option BUILD_BASIS_UTILITIES_FOR_CXX = OFF
 Whether to always build the BASIS C++ utilities even if not required by any target. More...
 
option BUILD_BASIS_UTILITIES_FOR_PERL = OFF
 Whether to always build the BASIS Perl utilities even if not required by any target. More...
 
option BUILD_BASIS_UTILITIES_FOR_PYTHON = OFF
 Whether to always build the BASIS Python utilities even if not required by any target. More...
 
string CMAKE_BUILD_TYPE
 
cmake CMAKE_BUILD_WITH_INSTALL_RPATH
 
cmake CMAKE_INSTALL_RPATH_USE_LINK_PATH
 
cmake CMAKE_SKIP_BUILD_RPATH
 
cmake CMAKE_SKIP_RPATH
 

Detailed Description

Default project-independent settings.

This module defines global CMake constants and variables which are used by the BASIS CMake functions and macros. Hence, these values can be used to configure the behavior of these functions to some extent without the need to modify the functions themselves.

Note
As this file also sets the CMake policies to be used, it has to be included using the NO_POLICY_SCOPE in order for these policies to take effect also in the including file and its subdirectories.
Attention
Be careful when caching any of the variables. Usually, this file is included in the root CMake configuration file of the project which may also be a module of another project and hence may overwrite this project's settings.
Keep in mind that this file is included before any other BASIS module. Further, project-specific information such as the project name are not defined yet.

Definition in file BasisSettings.cmake.

Variable Documentation

§ __BASIS_SETTINGS_INCLUDED

cmake __BASIS_SETTINGS_INCLUDED

Definition at line 38 of file BasisSettings.cmake.