BASISDirectories.cmake File Reference

CMake variables of project directories. More...

Go to the source code of this file.

Variables
	BASIS_INSTALL_SINFIX
	Installation sinfix.
	BASIS_PROJECT_BINARY_DIR
	Absolute path of root directory of build tree of top-level project.
	BASIS_PROJECT_SOURCE_DIR
	Absolute path of root directory of source tree of top-level project.
	BINARY_ARCHIVE_DIR
	Absolute path of output directory for static and import libraries.
	BINARY_LIBEXEC_DIR
	Absolute path of output directory for auxiliary executables.
	BINARY_LIBRARY_DIR
	Absolute path of output directory for shared libraries and modules.
	BINARY_PERL_LIBRARY_DIR
	Absolute path of output directory for Perl modules.
	BINARY_PYTHON_LIBRARY_DIR
	Absolute path of output directory for Python modules.
	BINARY_RUNTIME_DIR
	Absolute path of output directory for main executables.
	INSTALL_ARCHIVE_DIR
	Path of installation directory for static and import libraries relative to INSTALL_PREFIX.
	INSTALL_CONFIG_DIR
	Path of installation directory for CMake package configuration files relative to INSTALL_PREFIX.
	INSTALL_DATA_DIR
	Path of installation directory for shared data files relative to INSTALL_PREFIX.
	INSTALL_DOC_DIR
	Path of installation directory for documentation files relative to INSTALL_PREFIX.
	INSTALL_EXAMPLE_DIR
	Path of installation directory for example files relative to INSTALL_PREFIX.
	INSTALL_INCLUDE_DIR
	Path of installation directory for public header files relative to INSTALL_PREFIX.
	INSTALL_LIBEXEC_DIR
	Path of installation directory for auxiliary executables relative to INSTALL_PREFIX.
	INSTALL_LIBRARY_DIR
	Path of installation directory for shared libraries on Unix-based systems and module libraries relative to INSTALL_PREFIX.
	INSTALL_MAN_DIR
	Path of installation directory for man pages relative to INSTALL_PREFIX.
	INSTALL_PERL_LIBRARY_DIR
	Path of installation directory for Perl modules relative to INSTALL_PREFIX.
	INSTALL_PREFIX
	Installation prefix.
	INSTALL_PYTHON_LIBRARY_DIR
	Path of installation directory for Python modules relative to INSTALL_PREFIX.
	INSTALL_RUNTIME_DIR
	Path of installation directory for runtime executables and shared libraries on Windows relative to INSTALL_PREFIX.
	INSTALL_SHARE_DIR
	Path of installation directory for shared files relative to INSTALL_PREFIX.
option	INSTALL_SINFIX
	Whether to use installation sinfix.
	PROJECT_CODE_DIR
	Absolute path of directory of project sources in source tree.
	PROJECT_CONFIG_DIR
	Absolute path of directory of BASIS project configuration in source tree.
	PROJECT_DATA_DIR
	Absolute path of directory of auxiliary data in source tree.
	PROJECT_DOC_DIR
	Absolute path of directory of documentation files in source tree.
	PROJECT_EXAMPLE_DIR
	Absolute path of directory of example in source tree.
	PROJECT_INCLUDE_DIR
	Absolute path of diretory of public header files in source tree.
	PROJECT_MODULES_DIR
	Absolute path of directory of project modules.
	PROJECT_TESTING_DIR
	Absolute path of directory of testing tree in source tree.
	TESTING_LIBEXEC_DIR
	Absolute path of output directory for auxiliary executables used by tests.
	TESTING_LIBRARY_DIR
	Absolute path of output directory for testing libraries.
	TESTING_OUTPUT_DIR
	Absolute path of output directory for tests.
	TESTING_PERL_LIBRARY_DIR
	Absolute path of output directory for Perl modules used for testing.
	TESTING_PYTHON_LIBRARY_DIR
	Absolute path of output directory for Python modules used for testing.
	TESTING_RUNTIME_DIR
	Absolute path of output directory for built test executables.

---

Detailed Description

CMake variables of project directories.

Note:

The file BASISDirectories.cmake is automatically generated by BASIS from the template file Directories.cmake.in which is part of the BASIS installation. See Filesystem Hierarchy Standard.

The project must follow the directory structure as defined by the PROJECT_<*>_DIR variables.

Ideally, when changing the name of one of these directories, only the directory structure of the template needs to be updated. The BASIS CMake functions should not be required to change as they are supposed to use these variables instead of the actual names. Any change of the project directory structure has to be made with care, however, and backwards compatibility to previous releases of BASIS shall be maintained. Consider the use of the TEMPLATE_VERSION if required.

If this project is a module and modules shall reside in the same namespace as the top-level project (i.e., BASIS_USE_MODULE_NAMESPACES is OFF), the directories are the same for all modules except of the PROJECT_<*>_DIR variables, which refer to the source tree of the current module. Otherwise, the modules add their name to the paths such that the files of the modules are separated by subdirectories.

Copyright (c) 2011, 2012 University of Pennsylvania. All rights reserved.
See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.

Contact: SBIA Group <sbia-software at uphs.upenn.edu>

Definition in file BASISDirectories.cmake.