Skip to content
Permalink
Browse files

Merge pull request #4120 from STEllAR-GROUP/doc_updates_hpx_build_sys…

…tem_v1

Doc updates hpx build system v1
  • Loading branch information...
msimberg committed Oct 9, 2019
2 parents bfa2266 + 1ccc8bf commit 388ae0093ff805274382749e00e5ba1cae8e0bf4
Showing with 160 additions and 163 deletions.
  1. +4 −4 cmake/templates/cmake_toolchains.rst.in
  2. +13 −13 cmake/templates/cmake_variables.rst.in
  3. +143 −146 docs/sphinx/manual/building_hpx.rst
@@ -15,13 +15,13 @@
|cmake| toolchains shipped with |hpx|
=====================================

In order to compile HPX for various platforms, we provide a variety of toolchain
files that take care of setting up various |cmake| variables like compilers etc.
In order to compile |hpx| for various platforms, we provide a variety of toolchain
files that take care of setting up various |cmake| variables like compilers, etc.
They are located in the ``cmake/toolchains`` directory:

@HPX_CMAKE_TOOLCHAINS_LIST_RST@

To use them pass the ``-DCMAKE_TOOLCHAIN_FILE=<toolchain>`` argument to the
cmake invocation.
To use them, pass the ``-DCMAKE_TOOLCHAIN_FILE=<toolchain>`` argument to the
CMake invocation.

@HPX_CMAKE_TOOLCHAINS_RST@
@@ -15,7 +15,7 @@
|cmake| variables used to configure |hpx|
=========================================

In order to configure |hpx|, you can set a variety of options to allow cmake to
In order to configure |hpx|, you can set a variety of options to allow CMake to
generate your specific makefiles/project files.

.. _configure:
@@ -32,43 +32,43 @@ The options are split into these categories:
Additional tools and libraries used by |hpx|
--------------------------------------------

Here is a list of additional libraries and tools which are either optionally
Here is a list of additional libraries and tools that are either optionally
supported by the build system or are optionally required for certain examples or
tests. These libraries and tools can be detected by the |hpx| build system.

Each of the tools or libraries listed here will be automatically detected if
they are installed in some standard location. If a tool or library is installed
in a different location you can specify its base directory by appending
in a different location, you can specify its base directory by appending
``_ROOT`` to the variable name as listed below. For instance, to configure a
custom directory for ``BOOST``, specify ``BOOST_ROOT=/custom/boost/root``.

.. option:: BOOST_ROOT:PATH

Specifies where to look for the |boost|_ installation to be used for
compiling |hpx| Set this if CMake is not able to locate a suitable version of
|boost|_ The directory specified here can be either the root of a installed
Boost distribution or the directory where you unpacked and built |boost|_
Specifies where to look for the Boost installation to be used for
compiling |hpx|. Set this if CMake is not able to locate a suitable version of
Boost. The directory specified here can be either the root of an installed
Boost distribution or the directory where you unpacked and built Boost
without installing it (with staged libraries).

.. option:: HWLOC_ROOT:PATH

Specifies where to look for the |hwloc|_ library. Set this if CMake is not
able to locate a suitable version of |hwloc|_ |hwloc|_ provides platform
Specifies where to look for the hwloc library. Set this if CMake is not
able to locate a suitable version of hwloc. Hwloc provides platform-
independent support for extracting information about the used hardware
architecture (number of cores, number of NUMA domains, hyperthreading, etc.).
|hpx| utilizes this information if available.

.. option:: PAPI_ROOT:PATH

Specifies where to look for the |papi|_ library. The PAPI library is
necessary to compile a special component exposing PAPI hardware events and
Specifies where to look for the PAPI library. The PAPI library is
needed to compile a special component exposing PAPI hardware events and
counters as |hpx| performance counters. This is not available on the Windows
platform.

.. option:: AMPLIFIER_ROOT:PATH

Specifies where to look for one of the tools of the Intel Parallel Studio(tm)
product, either Intel Amplifier(tm) or Intel Inspector(tm). This should be
Specifies where to look for one of the tools of the Intel Parallel Studio
product, either Intel Amplifier or Intel Inspector. This should be
set if the CMake variable ``HPX_USE_ITT_NOTIFY`` is set to ``ON``. Enabling
ITT support in |hpx| will integrate any application with the mentioned Intel
tools, which customizes the generated information for your application and

0 comments on commit 388ae00

Please sign in to comment.
You can’t perform that action at this time.