Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added documentation for the compiler-wrapper script hpxcxx.in in creating_hpx_projects.rst #4414

Merged
merged 4 commits into from Jul 6, 2020
Merged

Added documentation for the compiler-wrapper script hpxcxx.in in creating_hpx_projects.rst #4414

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
29089ad
Added documentation for the compiler-wrapper script hpxcxx.in in crea…
MukundVaradarajan Feb 28, 2020
bc25024
Fixed sub-heading style according to guidelines
MukundVaradarajan Feb 28, 2020
43cfa68
Apply suggestions from code review
MukundVaradarajan Mar 9, 2020
9dbb6c8
Apply small formatting and language changes to hpxcxx documentation
msimberg Jun 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 23 additions & 1 deletion docs/sphinx/manual/creating_hpx_projects.rst
View file
Open in desktop
Expand Up @@ -297,6 +297,28 @@ variable to point to the installation of |hpx|.
in your targets. The |hpx| include directories are available with the
``HPX_INCLUDE_DIRS`` CMake variable.

.. _hpxcxx_documentation:

Building |hpx| Components and Applications
MukundVaradarajan marked this conversation as resolved.
Show resolved Hide resolved
------------------------------------------
The ``hpxcxx.in`` compiler wrapper in ``hpx/cmake/templates/`` directory helps to build a |hpx| component, an application or generate a ``<file-name>.o`` file, based on the arguments passed to it.
MukundVaradarajan marked this conversation as resolved.
Show resolved Hide resolved

MukundVaradarajan marked this conversation as resolved.
Show resolved Hide resolved
.. code-block :: bash

hpxcxx [--exe=<APPLICATION_NAME> | --comp=<COMPONENT_NAME> | -c] FLAGS FILES

The ``hpxcxx`` command **requires** that either an application or a component is built or ``-c`` flag is specified. If the build is against a debug build, the ``-g`` is to be specified while building.

Optional ``FLAGS``
..................

* ``-l <LIBRARY> | -l<LIBRARY>``: Links ``<LIBRARY>`` to the build
* ``-g``: Specifies that the application or component build is against a debug build
* ``-rd``: Sets ``release-with-debug-info`` option
* ``-mr``: Sets ``minsize-release`` option

All other flags (like ``-o OUTPUT_FILE``) are directly passed to the underlying C++ compiler.

.. _cmake_integrate_hpx:

CMake macros to integrate |hpx| into existing applications
Expand Down Expand Up @@ -346,7 +368,7 @@ to the section on :ref:`comps`.
.. _makefile:

Using |hpx| with Makefile
=======================
=========================

A basic project building with |hpx| is through creating makefiles. The process
of creating one can get complex depending upon the use of cmake parameter
Expand Down