Diff 33026

llvm/trunk/docs/CMake.rst

========================		========================
Building LLVM with CMake		Building LLVM with CMake
========================		========================

.. contents::		.. contents::
:local:		:local:

Introduction		Introduction
============		============

`CMake <http://www.cmake.org/>`_ is a cross-platform build-generator tool. CMake		`CMake <http://www.cmake.org/>`_ is a cross-platform build-generator tool. CMake
does not build the project, it generates the files needed by your build tool		does not build the project, it generates the files needed by your build tool
(GNU make, Visual Studio, etc) for building LLVM.		(GNU make, Visual Studio, etc.) for building LLVM.

If you are really anxious about getting a functional LLVM build, go to the		If you are really anxious about getting a functional LLVM build, go to the
`Quick start`_ section. If you are a CMake novice, start on `Basic CMake usage`_		`Quick start`_ section. If you are a CMake novice, start with `Basic CMake usage`_
and then go back to the `Quick start`_ once you know what you are doing. The		and then go back to the `Quick start`_ section once you know what you are doing. The
`Options and variables`_ section is a reference for customizing your build. If		`Options and variables`_ section is a reference for customizing your build. If
you already have experience with CMake, this is the recommended starting point.		you already have experience with CMake, this is the recommended starting point.

.. _Quick start:		.. _Quick start:

Quick start		Quick start
===========		===========

We use here the command-line, non-interactive CMake interface.		We use here the command-line, non-interactive CMake interface.

#. `Download <http://www.cmake.org/cmake/resources/software.html>`_ and install		#. `Download <http://www.cmake.org/cmake/resources/software.html>`_ and install
CMake. Version 2.8.8 is the minimum required.		CMake. Version 2.8.8 is the minimum required.

#. Open a shell. Your development tools must be reachable from this shell		#. Open a shell. Your development tools must be reachable from this shell
through the PATH environment variable.		through the PATH environment variable.

#. Create a directory for containing the build. It is not supported to build		#. Create a build directory. Building LLVM in the source
LLVM on the source directory. cd to this directory:		directory is not supported. cd to this directory:

.. code-block:: console		.. code-block:: console

$ mkdir mybuilddir		$ mkdir mybuilddir
$ cd mybuilddir		$ cd mybuilddir

#. Execute this command on the shell replacing `path/to/llvm/source/root` with		#. Execute this command in the shell replacing `path/to/llvm/source/root` with
the path to the root of your LLVM source tree:		the path to the root of your LLVM source tree:

.. code-block:: console		.. code-block:: console

$ cmake path/to/llvm/source/root		$ cmake path/to/llvm/source/root

CMake will detect your development environment, perform a series of test and		CMake will detect your development environment, perform a series of tests, and
generate the files required for building LLVM. CMake will use default values		generate the files required for building LLVM. CMake will use default values
for all build parameters. See the `Options and variables`_ section for		for all build parameters. See the `Options and variables`_ section for
fine-tuning your build		a list of build parameters that you can modify.

This can fail if CMake can't detect your toolset, or if it thinks that the		This can fail if CMake can't detect your toolset, or if it thinks that the
environment is not sane enough. On this case make sure that the toolset that		environment is not sane enough. In this case, make sure that the toolset that
you intend to use is the only one reachable from the shell and that the shell		you intend to use is the only one reachable from the shell, and that the shell
itself is the correct one for you development environment. CMake will refuse		itself is the correct one for your development environment. CMake will refuse
to build MinGW makefiles if you have a POSIX shell reachable through the PATH		to build MinGW makefiles if you have a POSIX shell reachable through the PATH
environment variable, for instance. You can force CMake to use a given build		environment variable, for instance. You can force CMake to use a given build
tool, see the `Usage`_ section.		tool; for instructions, see the `Usage`_ section, below.

#. After CMake has finished running, proceed to use IDE project files or start		#. After CMake has finished running, proceed to use IDE project files, or start
the build from the build directory:		the build from the build directory:

.. code-block:: console		.. code-block:: console

$ cmake --build .		$ cmake --build .

The ``--build`` option tells ``cmake`` to invoke the underlying build		The ``--build`` option tells ``cmake`` to invoke the underlying build
tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc).		tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc.)

The underlying build tool can be invoked directly either of course, but		The underlying build tool can be invoked directly, of course, but
the ``--build`` option is portable.		the ``--build`` option is portable.

#. After LLVM has finished building, install it from the build directory:		#. After LLVM has finished building, install it from the build directory:

.. code-block:: console		.. code-block:: console

$ cmake --build . --target install		$ cmake --build . --target install

Show All 9 Lines	.. code-block:: console
$ cmake -DCMAKE_INSTALL_PREFIX=/tmp/llvm -P cmake_install.cmake		$ cmake -DCMAKE_INSTALL_PREFIX=/tmp/llvm -P cmake_install.cmake

.. _Basic CMake usage:		.. _Basic CMake usage:
.. _Usage:		.. _Usage:

Basic CMake usage		Basic CMake usage
=================		=================

This section explains basic aspects of CMake, mostly for explaining those		This section explains basic aspects of CMake
options which you may need on your day-to-day usage.		which you may need in your day-to-day usage.

CMake comes with extensive documentation in the form of html files and on the		CMake comes with extensive documentation, in the form of html files, and as
cmake executable itself. Execute ``cmake --help`` for further help options.		online help accessible via the ``cmake`` executable itself. Execute ``cmake
		--help`` for further help options.
CMake requires to know for which build tool it shall generate files (GNU make,
Visual Studio, Xcode, etc). If not specified on the command line, it tries to		CMake allows you to specify a build tool (e.g., GNU make, Visual Studio,
guess it based on you environment. Once identified the build tool, CMake uses		or Xcode). If not specified on the command line, CMake tries to guess which
the corresponding Generator for creating files for your build tool. You can		build tool to use, based on your environment. Once it has identified your
		build tool, CMake uses the corresponding Generator to create files for your
		build tool (e.g., Makefiles or Visual Studio or Xcode project files). You can
explicitly specify the generator with the command line option ``-G "Name of the		explicitly specify the generator with the command line option ``-G "Name of the
generator"``. For knowing the available generators on your platform, execute		generator"``. To see a list of the available generators on your system, execute

.. code-block:: console		.. code-block:: console

$ cmake --help		$ cmake --help

This will list the generator's names at the end of the help text. Generator's		This will list the generator names at the end of the help text.
names are case-sensitive. Example:
		Generators' names are case-sensitive, and may contain spaces. For this reason,
		you should enter them exactly as they are listed in the ``cmake --help``
		output, in quotes. For example, to generate project files specifically for
		Visual Studio 12, you can execute:

.. code-block:: console		.. code-block:: console

$ cmake -G "Visual Studio 11" path/to/llvm/source/root		$ cmake -G "Visual Studio 12" path/to/llvm/source/root

For a given development platform there can be more than one adequate		For a given development platform there can be more than one adequate
generator. If you use Visual Studio "NMake Makefiles" is a generator you can use		generator. If you use Visual Studio, "NMake Makefiles" is a generator you can use
for building with NMake. By default, CMake chooses the more specific generator		for building with NMake. By default, CMake chooses the most specific generator
supported by your development environment. If you want an alternative generator,		supported by your development environment. If you want an alternative generator,
you must tell this to CMake with the ``-G`` option.		you must tell this to CMake with the ``-G`` option.

.. todo::		.. todo::

Explain variables and cache. Move explanation here from #options section.		Explain variables and cache. Move explanation here from #options section.

.. _Options and variables:		.. _Options and variables:

Options and variables		Options and variables
=====================		=====================

Variables customize how the build will be generated. Options are boolean		Variables customize how the build will be generated. Options are boolean
variables, with possible values ON/OFF. Options and variables are defined on the		variables, with possible values ON/OFF. Options and variables are defined on the
CMake command line like this:		CMake command line like this:

.. code-block:: console		.. code-block:: console

$ cmake -DVARIABLE=value path/to/llvm/source		$ cmake -DVARIABLE=value path/to/llvm/source

You can set a variable after the initial CMake invocation for changing its		You can set a variable after the initial CMake invocation to change its
value. You can also undefine a variable:		value. You can also undefine a variable:

.. code-block:: console		.. code-block:: console

$ cmake -UVARIABLE path/to/llvm/source		$ cmake -UVARIABLE path/to/llvm/source

Variables are stored on the CMake cache. This is a file named ``CMakeCache.txt``		Variables are stored in the CMake cache. This is a file named ``CMakeCache.txt``
on the root of the build directory. Do not hand-edit it.		stored at the root of your build directory that is generated by ``cmake``.
		Editing it yourself is not recommended.
Variables are listed here appending its type after a colon. It is correct to
write the variable and the type on the CMake command line:		Variables are listed in the CMake cache and later in this document with
		the variable name and type separated by a colon. You can also specify the
		variable and type on the CMake command line:

.. code-block:: console		.. code-block:: console

$ cmake -DVARIABLE:TYPE=value path/to/llvm/source		$ cmake -DVARIABLE:TYPE=value path/to/llvm/source

Frequently-used CMake variables		Frequently-used CMake variables
-------------------------------		-------------------------------

Here are some of the CMake variables that are used often, along with a		Here are some of the CMake variables that are used often, along with a
brief explanation and LLVM-specific notes. For full documentation, check the		brief explanation and LLVM-specific notes. For full documentation, consult the
CMake docs or execute ``cmake --help-variable VARIABLE_NAME``.		CMake manual, or execute ``cmake --help-variable VARIABLE_NAME``.

CMAKE_BUILD_TYPE:STRING		CMAKE_BUILD_TYPE:STRING
Sets the build type for ``make`` based generators. Possible values are		Sets the build type for ``make``-based generators. Possible values are
Release, Debug, RelWithDebInfo and MinSizeRel. On systems like Visual Studio		Release, Debug, RelWithDebInfo and MinSizeRel. If you are using an IDE such as
the user sets the build type with the IDE settings.		Visual Studio, you should use the IDE settings to set the build type.

CMAKE_INSTALL_PREFIX:PATH		CMAKE_INSTALL_PREFIX:PATH
Path where LLVM will be installed if "make install" is invoked or the		Path where LLVM will be installed if "make install" is invoked or the
"INSTALL" target is built.		"install" target is built.

LLVM_LIBDIR_SUFFIX:STRING		LLVM_LIBDIR_SUFFIX:STRING
Extra suffix to append to the directory where libraries are to be		Extra suffix to append to the directory where libraries are to be
installed. On a 64-bit architecture, one could use ``-DLLVM_LIBDIR_SUFFIX=64``		installed. On a 64-bit architecture, one could use ``-DLLVM_LIBDIR_SUFFIX=64``
to install libraries to ``/usr/lib64``.		to install libraries to ``/usr/lib64``.

CMAKE_C_FLAGS:STRING		CMAKE_C_FLAGS:STRING
Extra flags to use when compiling C source files.		Extra flags to use when compiling C source files.

CMAKE_CXX_FLAGS:STRING		CMAKE_CXX_FLAGS:STRING
Extra flags to use when compiling C++ source files.		Extra flags to use when compiling C++ source files.

BUILD_SHARED_LIBS:BOOL		BUILD_SHARED_LIBS:BOOL
Flag indicating if shared libraries will be built. Its default value is		Flag indicating if shared libraries will be built. Its default value is
OFF. Shared libraries are not supported on Windows and not recommended on the		OFF. This option is only recommended for use by LLVM developers.
other OSes.		On Windows, shared libraries may be used when building with MinGW, including
		mingw-w64, but not when building with the Microsoft toolchain.

.. _LLVM-specific variables:		.. _LLVM-specific variables:

LLVM-specific variables		LLVM-specific variables
-----------------------		-----------------------

LLVM_TARGETS_TO_BUILD:STRING		LLVM_TARGETS_TO_BUILD:STRING
Semicolon-separated list of targets to build, or all for building all		Semicolon-separated list of targets to build, or all for building all
targets. Case-sensitive. Defaults to all. Example:		targets. Case-sensitive. Defaults to all. Example:
``-DLLVM_TARGETS_TO_BUILD="X86;PowerPC"``.		``-DLLVM_TARGETS_TO_BUILD="X86;PowerPC"``.

LLVM_BUILD_TOOLS:BOOL		LLVM_BUILD_TOOLS:BOOL
Build LLVM tools. Defaults to ON. Targets for building each tool are generated		Build LLVM tools. Defaults to ON. Targets for building each tool are generated
in any case. You can build an tool separately by invoking its target. For		in any case. You can build a tool separately by invoking its target. For
example, you can build llvm-as with a makefile-based system executing *make		example, you can build llvm-as with a Makefile-based system by executing *make
llvm-as* on the root of your build directory.		llvm-as* at the root of your build directory.

LLVM_INCLUDE_TOOLS:BOOL		LLVM_INCLUDE_TOOLS:BOOL
Generate build targets for the LLVM tools. Defaults to ON. You can use that		Generate build targets for the LLVM tools. Defaults to ON. You can use this
option for disabling the generation of build targets for the LLVM tools.		option to disable the generation of build targets for the LLVM tools.

LLVM_BUILD_EXAMPLES:BOOL		LLVM_BUILD_EXAMPLES:BOOL
Build LLVM examples. Defaults to OFF. Targets for building each example are		Build LLVM examples. Defaults to OFF. Targets for building each example are
generated in any case. See documentation for LLVM_BUILD_TOOLS above for more		generated in any case. See documentation for LLVM_BUILD_TOOLS above for more
details.		details.

LLVM_INCLUDE_EXAMPLES:BOOL		LLVM_INCLUDE_EXAMPLES:BOOL
Generate build targets for the LLVM examples. Defaults to ON. You can use that		Generate build targets for the LLVM examples. Defaults to ON. You can use this
option for disabling the generation of build targets for the LLVM examples.		option to disable the generation of build targets for the LLVM examples.

LLVM_BUILD_TESTS:BOOL		LLVM_BUILD_TESTS:BOOL
Build LLVM unit tests. Defaults to OFF. Targets for building each unit test		Build LLVM unit tests. Defaults to OFF. Targets for building each unit test
are generated in any case. You can build a specific unit test with the target		are generated in any case. You can build a specific unit test using the
UnitTestNameTests (where at this time UnitTestName can be ADT, Analysis,		targets defined under unittests, such as ADTTests, IRTests, SupportTests,
ExecutionEngine, JIT, Support, Transform, VMCore; see the subdirectories of		etc. (Search for ``add_llvm_unittest`` in the subdirectories of unittests
unittests for an updated list.) It is possible to build all unit tests with		for a complete list of unit tests.) It is possible to build all unit tests
the target UnitTests.		with the target UnitTests.

LLVM_INCLUDE_TESTS:BOOL		LLVM_INCLUDE_TESTS:BOOL
Generate build targets for the LLVM unit tests. Defaults to ON. You can use		Generate build targets for the LLVM unit tests. Defaults to ON. You can use
that option for disabling the generation of build targets for the LLVM unit		this option to disable the generation of build targets for the LLVM unit
tests.		tests.

LLVM_APPEND_VC_REV:BOOL		LLVM_APPEND_VC_REV:BOOL
Append version control revision info (svn revision number or Git revision id)		Append version control revision info (svn revision number or Git revision id)
to LLVM version string (stored in the PACKAGE_VERSION macro). For this to work		to LLVM version string (stored in the PACKAGE_VERSION macro). For this to work
cmake must be invoked before the build. Defaults to OFF.		cmake must be invoked before the build. Defaults to OFF.

LLVM_ENABLE_THREADS:BOOL		LLVM_ENABLE_THREADS:BOOL
Build with threads support, if available. Defaults to ON.		Build with threads support, if available. Defaults to ON.

LLVM_ENABLE_CXX1Y:BOOL		LLVM_ENABLE_CXX1Y:BOOL
Build in C++1y mode, if available. Defaults to OFF.		Build in C++1y mode, if available. Defaults to OFF.

LLVM_ENABLE_ASSERTIONS:BOOL		LLVM_ENABLE_ASSERTIONS:BOOL
Enables code assertions. Defaults to ON if and only if ``CMAKE_BUILD_TYPE``		Enables code assertions. Defaults to ON if and only if ``CMAKE_BUILD_TYPE``
is Debug.		is Debug.

LLVM_ENABLE_EH:BOOL		LLVM_ENABLE_EH:BOOL
Build LLVM with exception handling support. This is necessary if you wish to		Build LLVM with exception-handling support. This is necessary if you wish to
link against LLVM libraries and make use of C++ exceptions in your own code		link against LLVM libraries and make use of C++ exceptions in your own code
that need to propagate through LLVM code. Defaults to OFF.		that need to propagate through LLVM code. Defaults to OFF.

LLVM_ENABLE_PIC:BOOL		LLVM_ENABLE_PIC:BOOL
Add the ``-fPIC`` flag for the compiler command-line, if the compiler supports		Add the ``-fPIC`` flag to the compiler command-line, if the compiler supports
this flag. Some systems, like Windows, do not need this flag. Defaults to ON.		this flag. Some systems, like Windows, do not need this flag. Defaults to ON.

LLVM_ENABLE_RTTI:BOOL		LLVM_ENABLE_RTTI:BOOL
Build LLVM with run time type information. Defaults to OFF.		Build LLVM with run-time type information. Defaults to OFF.

LLVM_ENABLE_WARNINGS:BOOL		LLVM_ENABLE_WARNINGS:BOOL
Enable all compiler warnings. Defaults to ON.		Enable all compiler warnings. Defaults to ON.

LLVM_ENABLE_PEDANTIC:BOOL		LLVM_ENABLE_PEDANTIC:BOOL
Enable pedantic mode. This disables compiler specific extensions, if		Enable pedantic mode. This disables compiler-specific extensions, if
possible. Defaults to ON.		possible. Defaults to ON.

LLVM_ENABLE_WERROR:BOOL		LLVM_ENABLE_WERROR:BOOL
Stop and fail build, if a compiler warning is triggered. Defaults to OFF.		Stop and fail the build, if a compiler warning is triggered. Defaults to OFF.

LLVM_ABI_BREAKING_CHECKS:STRING		LLVM_ABI_BREAKING_CHECKS:STRING
Used to decide if LLVM should be built with ABI breaking checks or		Used to decide if LLVM should be built with ABI breaking checks or
not. Allowed values are `WITH_ASSERTS` (default), `FORCE_ON` and		not. Allowed values are `WITH_ASSERTS` (default), `FORCE_ON` and
`FORCE_OFF`. `WITH_ASSERTS` turns on ABI breaking checks in an		`FORCE_OFF`. `WITH_ASSERTS` turns on ABI breaking checks in an
assertion enabled build. `FORCE_ON` (`FORCE_OFF`) turns them on		assertion enabled build. `FORCE_ON` (`FORCE_OFF`) turns them on
(off) irrespective of whether normal (`NDEBUG` based) assertions are		(off) irrespective of whether normal (`NDEBUG`-based) assertions are
enabled or not. A version of LLVM built with ABI breaking checks		enabled or not. A version of LLVM built with ABI breaking checks
is not ABI compatible with a version built without it.		is not ABI compatible with a version built without it.

LLVM_BUILD_32_BITS:BOOL		LLVM_BUILD_32_BITS:BOOL
Build 32-bits executables and libraries on 64-bits systems. This option is		Build 32-bit executables and libraries on 64-bit systems. This option is
available only on some 64-bits unix systems. Defaults to OFF.		available only on some 64-bit Unix systems. Defaults to OFF.

LLVM_TARGET_ARCH:STRING		LLVM_TARGET_ARCH:STRING
LLVM target to use for native code generation. This is required for JIT		LLVM target to use for native code generation. This is required for JIT
generation. It defaults to "host", meaning that it shall pick the architecture		generation. It defaults to "host", meaning that it shall pick the architecture
of the machine where LLVM is being built. If you are cross-compiling, set it		of the machine where LLVM is being built. If you are cross-compiling, set it
to the target architecture name.		to the target architecture name.

LLVM_TABLEGEN:STRING		LLVM_TABLEGEN:STRING
Full path to a native TableGen executable (usually named ``tblgen``). This is		Full path to a native TableGen executable (usually named ``llvm-tblgen``). This is
intended for cross-compiling: if the user sets this variable, no native		intended for cross-compiling: if the user sets this variable, no native
TableGen will be created.		TableGen will be created.

LLVM_LIT_ARGS:STRING		LLVM_LIT_ARGS:STRING
Arguments given to lit. ``make check`` and ``make clang-test`` are affected.		Arguments given to lit. ``make check`` and ``make clang-test`` are affected.
By default, ``'-sv --no-progress-bar'`` on Visual C++ and Xcode, ``'-sv'`` on		By default, ``'-sv --no-progress-bar'`` on Visual C++ and Xcode, ``'-sv'`` on
others.		others.

LLVM_LIT_TOOLS_DIR:PATH		LLVM_LIT_TOOLS_DIR:PATH
The path to GnuWin32 tools for tests. Valid on Windows host. Defaults to "",		The path to GnuWin32 tools for tests. Valid on Windows host. Defaults to
then Lit seeks tools according to %PATH%. Lit can find tools(eg. grep, sort,		the empty string, in which case lit will look for tools needed for tests
&c) on LLVM_LIT_TOOLS_DIR at first, without specifying GnuWin32 to %PATH%.		(e.g. ``grep``, ``sort``, etc.) in your %PATH%. If GnuWin32 is not in your
		%PATH%, then you can set this variable to the GnuWin32 directory so that
		lit can find tools needed for tests in that directory.

LLVM_ENABLE_FFI:BOOL		LLVM_ENABLE_FFI:BOOL
Indicates whether LLVM Interpreter will be linked with Foreign Function		Indicates whether the LLVM Interpreter will be linked with the Foreign Function
Interface library. If the library or its headers are installed on a custom		Interface library (libffi) in order to enable calling external functions.
location, you can set the variables FFI_INCLUDE_DIR and		If the library or its headers are installed in a custom
FFI_LIBRARY_DIR. Defaults to OFF.		location, you can also set the variables FFI_INCLUDE_DIR and
		FFI_LIBRARY_DIR to the directories where ffi.h and libffi.so can be found,
		respectively. Defaults to OFF.

LLVM_EXTERNAL_{CLANG,LLD,POLLY}_SOURCE_DIR:PATH		LLVM_EXTERNAL_{CLANG,LLD,POLLY}_SOURCE_DIR:PATH
Path to ``{Clang,lld,Polly}``\'s source directory. Defaults to		These variables specify the path to the source directory for the external
``tools/{clang,lld,polly}``. ``{Clang,lld,Polly}`` will not be built when it		LLVM projects Clang, lld, and Polly, respectively, relative to the top-level
is empty or it does not point to a valid path.		source directory. If the in-tree subdirectory for an external project
		exists (e.g., llvm/tools/clang for Clang), then the corresponding variable
		will not be used. If the variable for an external project does not point
		to a valid path, then that project will not be built.

LLVM_USE_OPROFILE:BOOL		LLVM_USE_OPROFILE:BOOL
Enable building OProfile JIT support. Defaults to OFF		Enable building OProfile JIT support. Defaults to OFF.

LLVM_USE_INTEL_JITEVENTS:BOOL		LLVM_USE_INTEL_JITEVENTS:BOOL
Enable building support for Intel JIT Events API. Defaults to OFF		Enable building support for Intel JIT Events API. Defaults to OFF.

LLVM_ENABLE_ZLIB:BOOL		LLVM_ENABLE_ZLIB:BOOL
Build with zlib to support compression/uncompression in LLVM tools.		Enable building with zlib to support compression/uncompression in LLVM tools.
Defaults to ON.		Defaults to ON.

LLVM_USE_SANITIZER:STRING		LLVM_USE_SANITIZER:STRING
Define the sanitizer used to build LLVM binaries and tests. Possible values		Define the sanitizer used to build LLVM binaries and tests. Possible values
are ``Address``, ``Memory``, ``MemoryWithOrigins``, ``Undefined``, ``Thread``,		are ``Address``, ``Memory``, ``MemoryWithOrigins``, ``Undefined``, ``Thread``,
and ``Address;Undefined``. Defaults to empty string.		and ``Address;Undefined``. Defaults to empty string.

LLVM_PARALLEL_COMPILE_JOBS:STRING		LLVM_PARALLEL_COMPILE_JOBS:STRING
Show All 22 Lines

LLVM_DOXYGEN_QCH_FILENAME:STRING		LLVM_DOXYGEN_QCH_FILENAME:STRING
The filename of the Qt Compressed Help file that will be generated when		The filename of the Qt Compressed Help file that will be generated when
``-DLLVM_ENABLE_DOXYGEN=ON`` and		``-DLLVM_ENABLE_DOXYGEN=ON`` and
``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON`` are given. Defaults to		``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON`` are given. Defaults to
``org.llvm.qch``.		``org.llvm.qch``.
This option is only useful in combination with		This option is only useful in combination with
``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;		``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
otherwise this has no effect.		otherwise it has no effect.

LLVM_DOXYGEN_QHP_NAMESPACE:STRING		LLVM_DOXYGEN_QHP_NAMESPACE:STRING
Namespace under which the intermediate Qt Help Project file lives. See `Qt		Namespace under which the intermediate Qt Help Project file lives. See `Qt
Help Project`_		Help Project`_
for more information. Defaults to "org.llvm". This option is only useful in		for more information. Defaults to "org.llvm". This option is only useful in
combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise		combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise
this has no effect.		it has no effect.

LLVM_DOXYGEN_QHP_CUST_FILTER_NAME:STRING		LLVM_DOXYGEN_QHP_CUST_FILTER_NAME:STRING
See `Qt Help Project`_ for		See `Qt Help Project`_ for
more information. Defaults to the CMake variable ``${PACKAGE_STRING}`` which		more information. Defaults to the CMake variable ``${PACKAGE_STRING}`` which
is a combination of the package name and version string. This filter can then		is a combination of the package name and version string. This filter can then
be used in Qt Creator to select only documentation from LLVM when browsing		be used in Qt Creator to select only documentation from LLVM when browsing
through all the help files that you might have loaded. This option is only		through all the help files that you might have loaded. This option is only
useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;		useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
otherwise this has no effect.		otherwise it has no effect.

.. _Qt Help Project: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters		.. _Qt Help Project: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters

LLVM_DOXYGEN_QHELPGENERATOR_PATH:STRING		LLVM_DOXYGEN_QHELPGENERATOR_PATH:STRING
The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's		The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's
``find_program()`` can find. This option is only useful in combination with		``find_program()`` can find. This option is only useful in combination with
``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise this has no		``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise it has no
effect.		effect.

LLVM_DOXYGEN_SVG:BOOL		LLVM_DOXYGEN_SVG:BOOL
Uses .svg files instead of .png files for graphs in the Doxygen output.		Uses .svg files instead of .png files for graphs in the Doxygen output.
Defaults to OFF.		Defaults to OFF.

LLVM_ENABLE_SPHINX:BOOL		LLVM_ENABLE_SPHINX:BOOL
If enabled CMake will search for the ``sphinx-build`` executable and will make		If enabled CMake will search for the ``sphinx-build`` executable and will make
Show All 18 Lines

SPHINX_WARNINGS_AS_ERRORS:BOOL		SPHINX_WARNINGS_AS_ERRORS:BOOL
If enabled then sphinx documentation warnings will be treated as		If enabled then sphinx documentation warnings will be treated as
errors. Defaults to ON.		errors. Defaults to ON.

Executing the test suite		Executing the test suite
========================		========================

Testing is performed when the check target is built. For instance, if you are		Testing is performed when the check-all target is built. For instance, if you are
using makefiles, execute this command while on the top level of your build		using Makefiles, execute this command in the root of your build directory:
directory:

.. code-block:: console		.. code-block:: console

$ make check		$ make check-all

On Visual Studio, you may run tests to build the project "check".		On Visual Studio, you may run tests by building the project "check-all".
		For more information about testing, see the :doc:`TestingGuide`.

Cross compiling		Cross compiling
===============		===============

See `this wiki page <http://www.vtk.org/Wiki/CMake_Cross_Compiling>`_ for		See `this wiki page <http://www.vtk.org/Wiki/CMake_Cross_Compiling>`_ for
generic instructions on how to cross-compile with CMake. It goes into detailed		generic instructions on how to cross-compile with CMake. It goes into detailed
explanations and may seem daunting, but it is not. On the wiki page there are		explanations and may seem daunting, but it is not. On the wiki page there are
several examples including toolchain files. Go directly to `this section		several examples including toolchain files. Go directly to `this section
<http://www.vtk.org/Wiki/CMake_Cross_Compiling#Information_how_to_set_up_various_cross_compiling_toolchains>`_		<http://www.vtk.org/Wiki/CMake_Cross_Compiling#Information_how_to_set_up_various_cross_compiling_toolchains>`_
for a quick solution.		for a quick solution.

Also see the `LLVM-specific variables`_ section for variables used when		Also see the `LLVM-specific variables`_ section for variables used when
cross-compiling.		cross-compiling.

Embedding LLVM in your project		Embedding LLVM in your project
==============================		==============================

From LLVM 3.5 onwards both the CMake and autoconf/Makefile build systems export		From LLVM 3.5 onwards both the CMake and autoconf/Makefile build systems export
LLVM libraries as importable CMake targets. This means that clients of LLVM can		LLVM libraries as importable CMake targets. This means that clients of LLVM can
now reliably use CMake to develop their own LLVM based projects against an		now reliably use CMake to develop their own LLVM-based projects against an
installed version of LLVM regardless of how it was built.		installed version of LLVM regardless of how it was built.

Here is a simple example of CMakeLists.txt file that imports the LLVM libraries		Here is a simple example of a CMakeLists.txt file that imports the LLVM libraries
and uses them to build a simple application ``simple-tool``.		and uses them to build a simple application ``simple-tool``.

.. code-block:: cmake		.. code-block:: cmake

cmake_minimum_required(VERSION 2.8.8)		cmake_minimum_required(VERSION 2.8.8)
project(SimpleProject)		project(SimpleProject)

find_package(LLVM REQUIRED CONFIG)		find_package(LLVM REQUIRED CONFIG)
Show All 28 Lines

This file is available in two different locations.		This file is available in two different locations.

* ``<INSTALL_PREFIX>/share/llvm/cmake/LLVMConfig.cmake`` where		* ``<INSTALL_PREFIX>/share/llvm/cmake/LLVMConfig.cmake`` where
``<INSTALL_PREFIX>`` is the install prefix of an installed version of LLVM.		``<INSTALL_PREFIX>`` is the install prefix of an installed version of LLVM.
On Linux typically this is ``/usr/share/llvm/cmake/LLVMConfig.cmake``.		On Linux typically this is ``/usr/share/llvm/cmake/LLVMConfig.cmake``.

* ``<LLVM_BUILD_ROOT>/share/llvm/cmake/LLVMConfig.cmake`` where		* ``<LLVM_BUILD_ROOT>/share/llvm/cmake/LLVMConfig.cmake`` where
``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note this only		``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note: this is only
available when building LLVM with CMake**		available when building LLVM with CMake.**

If LLVM is installed in your operating system's normal installation prefix (e.g.		If LLVM is installed in your operating system's normal installation prefix (e.g.
on Linux this is usually ``/usr/``) ``find_package(LLVM ...)`` will		on Linux this is usually ``/usr/``) ``find_package(LLVM ...)`` will
automatically find LLVM if it is installed correctly. If LLVM is not installed		automatically find LLVM if it is installed correctly. If LLVM is not installed
or you wish to build directly against the LLVM build tree you can use		or you wish to build directly against the LLVM build tree you can use
``LLVM_DIR`` as previously mentioned.		``LLVM_DIR`` as previously mentioned.

The ``LLVMConfig.cmake`` file sets various useful variables. Notable variables		The ``LLVMConfig.cmake`` file sets various useful variables. Notable variables
Show All 16 Lines
``LLVM_ENABLE_RTTI``		``LLVM_ENABLE_RTTI``
This is set to ON if LLVM was built with run time type information (RTTI),		This is set to ON if LLVM was built with run time type information (RTTI),
otherwise OFF.		otherwise OFF.

``LLVM_INCLUDE_DIRS``		``LLVM_INCLUDE_DIRS``
A list of include paths to directories containing LLVM header files.		A list of include paths to directories containing LLVM header files.

``LLVM_PACKAGE_VERSION``		``LLVM_PACKAGE_VERSION``
The LLVM version. This string can be used with CMake conditionals. E.g. ``if		The LLVM version. This string can be used with CMake conditionals, e.g., ``if
(${LLVM_PACKAGE_VERSION} VERSION_LESS "3.5")``.		(${LLVM_PACKAGE_VERSION} VERSION_LESS "3.5")``.

``LLVM_TOOLS_BINARY_DIR``		``LLVM_TOOLS_BINARY_DIR``
The path to the directory containing the LLVM tools (e.g. ``llvm-as``).		The path to the directory containing the LLVM tools (e.g. ``llvm-as``).

Notice that in the above example we link ``simple-tool`` against several LLVM		Notice that in the above example we link ``simple-tool`` against several LLVM
libraries. The list of libraries is determined by using the		libraries. The list of libraries is determined by using the
``llvm_map_components_to_libnames()`` CMake function. For a list of available		``llvm_map_components_to_libnames()`` CMake function. For a list of available
Show All 36 Lines
Contents of ``<project dir>/<pass name>/CMakeLists.txt``:		Contents of ``<project dir>/<pass name>/CMakeLists.txt``:

.. code-block:: cmake		.. code-block:: cmake

add_library(LLVMPassname MODULE Pass.cpp)		add_library(LLVMPassname MODULE Pass.cpp)

Note if you intend for this pass to be merged into the LLVM source tree at some		Note if you intend for this pass to be merged into the LLVM source tree at some
point in the future it might make more sense to use LLVM's internal		point in the future it might make more sense to use LLVM's internal
add_llvm_loadable_module function instead by...		``add_llvm_loadable_module`` function instead by...


Adding the following to ``<project dir>/CMakeLists.txt`` (after		Adding the following to ``<project dir>/CMakeLists.txt`` (after
``find_package(LLVM ...)``)		``find_package(LLVM ...)``)

.. code-block:: cmake		.. code-block:: cmake

list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")		list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
include(AddLLVM)		include(AddLLVM)

And then changing ``<project dir>/<pass name>/CMakeLists.txt`` to		And then changing ``<project dir>/<pass name>/CMakeLists.txt`` to

.. code-block:: cmake		.. code-block:: cmake

add_llvm_loadable_module(LLVMPassname		add_llvm_loadable_module(LLVMPassname
Pass.cpp		Pass.cpp
)		)

When you are done developing your pass, you may wish to integrate it		When you are done developing your pass, you may wish to integrate it
into LLVM source tree. You can achieve it in two easy steps:		into the LLVM source tree. You can achieve it in two easy steps:

#. Copying ``<pass name>`` folder into ``<LLVM root>/lib/Transform`` directory.		#. Copying ``<pass name>`` folder into ``<LLVM root>/lib/Transform`` directory.

#. Adding ``add_subdirectory(<pass name>)`` line into		#. Adding ``add_subdirectory(<pass name>)`` line into
``<LLVM root>/lib/Transform/CMakeLists.txt``.		``<LLVM root>/lib/Transform/CMakeLists.txt``.

Compiler/Platform-specific topics		Compiler/Platform-specific topics
=================================		=================================

Notes for specific compilers and/or platforms.		Notes for specific compilers and/or platforms.

Microsoft Visual C++		Microsoft Visual C++
--------------------		--------------------

LLVM_COMPILER_JOBS:STRING		LLVM_COMPILER_JOBS:STRING
Specifies the maximum number of parallell compiler jobs to use per project		Specifies the maximum number of parallel compiler jobs to use per project
when building with msbuild or Visual Studio. Only supported for the Visual		when building with msbuild or Visual Studio. Only supported for the Visual
Studio 2010 CMake generator. 0 means use all processors. Default is 0.		Studio 2010 CMake generator. 0 means use all processors. Default is 0.

This is an archive of the discontinued LLVM Phabricator instance.

Edits to CMake.rst for clarity's sake
ClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 33026

llvm/trunk/docs/CMake.rst

This is an archive of the discontinued LLVM Phabricator instance.

Edits to CMake.rst for clarity's sakeClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 33026

llvm/trunk/docs/CMake.rst

Edits to CMake.rst for clarity's sake
ClosedPublic