Page MenuHomePhabricator

Please use GitHub pull requests for new patches. Phabricator shutdown timeline

Differential D2967 Diff 7647 llvm/trunk/docs/CMake.rst

Changeset View

Standalone View

View Options

llvm/trunk/docs/CMake.rst

Show First 20 Lines • Show All 277 Lines • ▼ Show 20 Lines**LLVM_ENABLE_ZLIB**:BOOL
Build with zlib to support compression/uncompression in LLVM tools. Build 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`` and ``MemoryWithOrigins``. Defaults to empty are ``Address``, ``Memory`` and ``MemoryWithOrigins``. Defaults to empty
string. string.
**LLVM_ENABLE_DOXYGEN**:BOOL
Enables the generation of browsable HTML documentation using doxygen.
Defaults to OFF.
**LLVM_ENABLE_DOXYGEN_QT_HELP**:BOOL
Enables the generation of a Qt Compressed Help file. Defaults to OFF.
This affects the make target ``doxygen-llvm``. When enabled, apart from
the normal HTML output generated by doxygen, this will produce a QCH file
named ``org.llvm.qch``. You can then load this file into Qt Creator.
This option is only useful in combination with ``-DLLVM_ENABLE_DOXYGEN=ON``;
otherwise this has no effect.
**LLVM_DOXYGEN_QCH_FILENAME**:STRING
The filename of the Qt Compressed Help file that will be genrated when
``-DLLVM_ENABLE_DOXYGEN=ON`` and
``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON`` are given. Defaults to
``org.llvm.qch``.
This option is only useful in combination with
``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
otherwise this has no effect.
**LLVM_DOXYGEN_QHP_NAMESPACE**:STRING
Namespace under which the intermediate Qt Help Project file lives. See `Qt
Help Project <http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace>`_
for more information. Defaults to "org.llvm". This option is only useful in
combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise
this has no effect.
**LLVM_DOXYGEN_QHP_CUST_FILTER_NAME**:STRING
See `Qt Help Project
<http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters>`_ for
more information. Defaults to the CMake variable ``${PACKAGE_STRING}`` which
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
through all the help files that you might have loaded. This option is only
useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
otherwise this has no effect.
**LLVM_DOXYGEN_QHELPGENERATOR_PATH**:STRING
The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's
``find_program()`` can find. This option is only useful in combination with
``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise this has no
effect.
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* 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 while on the top level of your build
directory: directory:
.. code-block:: console .. code-block:: console
▲ Show 20 Lines • Show All 136 Lines • Show Last 20 Lines