Skip to content

Commit

Permalink
chore: rebase onto master
Browse files Browse the repository at this point in the history
  • Loading branch information
bhumitattarde committed Oct 6, 2022
2 parents 1859c03 + 864538f commit 9e5ac23
Show file tree
Hide file tree
Showing 46 changed files with 2,009 additions and 320 deletions.
20 changes: 1 addition & 19 deletions cmake/HPX_Documentation.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

# find required packages
if(HPX_WITH_DOCUMENTATION)
find_package(Doxygen)
find_package(Sphinx)
Expand All @@ -27,22 +28,3 @@ if(HPX_WITH_DOCUMENTATION)
set(HPX_WITH_DOCUMENTATION OFF)
endif()
endif()

# C++ Source -> Doxygen XML
function(hpx_source_to_doxygen name)
set(options)
set(one_value_args)
set(multi_value_args DEPENDENCIES DOXYGEN_ARGS)
cmake_parse_arguments(
${name} "${options}" "${one_value_args}" "${multi_value_args}" ${ARGN}
)

add_custom_command(
OUTPUT "${name}/index.xml"
COMMAND "${DOXYGEN_EXECUTABLE}" ${${name}_DOXYGEN_ARGS}
"${CMAKE_CURRENT_BINARY_DIR}/${name}.doxy"
COMMENT "Generating Doxygen."
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${name}.doxy" ${${name}_DEPENDENCIES}
VERBATIM
)
endfunction()
18 changes: 0 additions & 18 deletions cmake/templates/autodoc.doxy.in

This file was deleted.

9 changes: 9 additions & 0 deletions cmake/templates/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,13 @@ breathe_doxygen_config_options = {
'PREDEFINED': '@doxygen_definitions@',
'STRIP_FROM_PATH': hpx_source_dir,
'EXTRACT_PRIVATE': 'NO'
'ALIASES': r'namedrequirement{1}="<a href=\"https://en.cppreference.com/w/cpp/named_req/\1\">\1</a>"'
}

# ! this should work but doesn't. check after updating breathe version.
# breathe_doxygen_aliases = {
# }

numfig = True
primary_domain = 'cpp'
highlight_language = 'cpp'
Expand Down Expand Up @@ -496,6 +501,10 @@ rst_prolog += '''
.. _cpp20_p0075r1: http://wg21.link/p0075r1
.. |cpp20_p0443| replace:: P0443
.. _cpp20_p0443: https://github.com/executors/issaquah_2016
.. |p0792| replace:: P0792
.. _p0792: http://wg21.link/p0792
.. |p0159| replace:: P0159
.. _p0159: http://wg21.link/p0159
.. |p1393| replace:: P1393
.. _p1393: http://wg21.link/p1393
.. |p2220| replace:: P2220
Expand Down
2 changes: 2 additions & 0 deletions cmake/templates/hpxcxx.in
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,14 @@ if pkg in os.environ:
else:
os.environ[pkg] = pkgconf

args += ["-Wl,--start-group"]
if application:
args += ["`pkg-config --cflags --libs hpx_application" + pkgconf_suffix + "`"]
elif component:
args += ["`pkg-config --cflags --libs hpx_component" + pkgconf_suffix + "`"]
else:
args += ["`pkg-config --cflags hpx_application" + pkgconf_suffix + "`"]
args += ["-Wl,--end-group"]

if not component and not application and not minusc:
usage()
Expand Down
24 changes: 1 addition & 23 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,7 @@
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

# Add all files here which should be passed to doxygen
set(doxygen_dependencies
"${PROJECT_SOURCE_DIR}/components/component_storage/include/hpx/components/component_storage/migrate_from_storage.hpp"
"${PROJECT_SOURCE_DIR}/components/component_storage/include/hpx/components/component_storage/migrate_to_storage.hpp"
)

# Definitions for autodoc.doxy.in
foreach(doxygen_input ${doxygen_dependencies})
set(doxygen_inputs "${doxygen_inputs} ${doxygen_input}")
endforeach()

set(doxygen_output_file "${CMAKE_CURRENT_BINARY_DIR}/hpx_autodoc")
set(doxygen_output_dir "${CMAKE_CURRENT_BINARY_DIR}/doxygen")

# used while generating sphinx config file
set(doxygen_definition_list
"DOXYGEN:=1"
"BOOST_SYSTEM_NOEXCEPT="
Expand All @@ -36,12 +23,6 @@ foreach(doxygen_predef ${doxygen_definition_list})
set(doxygen_definitions "${doxygen_definitions} \"${doxygen_predef}\"")
endforeach()

hpx_info("Creating Doxyfile: ${CMAKE_CURRENT_BINARY_DIR}/hpx_autodoc.doxy")
configure_file(
"${PROJECT_SOURCE_DIR}/cmake/templates/autodoc.doxy.in"
"${CMAKE_CURRENT_BINARY_DIR}/hpx_autodoc.doxy" @ONLY
)

# Generate rst files with CMake variables and toolchains
set(HPX_CMAKE_OPTIONS_RST "")
foreach(_cat ${HPX_OPTION_CATEGORIES})
Expand Down Expand Up @@ -215,8 +196,6 @@ create_symbolic_link(
"${PROJECT_SOURCE_DIR}/libs" "${CMAKE_CURRENT_BINARY_DIR}/libs"
)

hpx_source_to_doxygen(hpx_autodoc DEPENDENCIES ${doxygen_dependencies})

add_custom_target(docs)
add_custom_target(docs-html)
add_custom_target(docs-singlehtml)
Expand Down Expand Up @@ -258,7 +237,6 @@ foreach(output_format ${HPX_WITH_DOCUMENTATION_OUTPUT_FORMATS})
add_custom_command(
OUTPUT "${SPHINX_DOCS_OUTPUT_FILE}"
DEPENDS "${sphinx_source_files_build}"
"${CMAKE_CURRENT_BINARY_DIR}/hpx_autodoc/index.xml"
COMMAND ${SPHINX_DOCS_BUILD_COMMAND}
)

Expand Down
10 changes: 5 additions & 5 deletions docs/sphinx/api/public_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ Classes
Class C++ standard
============================================= =============================================================
:cpp:class:`hpx::function` :cppreference-generic:`utility/functional,function`
:cpp:class:`hpx::function_ref`
:cpp:class:`hpx::function_ref` |p0792|_
:cpp:class:`hpx::move_only_function` :cppreference-generic:`utility/functional,move_only_function`
:cpp:struct:`hpx::traits::is_bind_expression` :cppreference-generic:`utility/functional,is_bind_expression`
:cpp:struct:`hpx::traits::is_placeholder` :cppreference-generic:`utility/functional,is_placeholder`
Expand Down Expand Up @@ -541,13 +541,13 @@ Functions
:cpp:func:`hpx::dataflow`
:cpp:func:`hpx::make_future`
:cpp:func:`hpx::make_shared_future`
:cpp:func:`hpx::make_ready_future`
:cpp:func:`hpx::make_ready_future` |p0159|_
:cpp:func:`hpx::make_ready_future_alloc`
:cpp:func:`hpx::make_ready_future_at`
:cpp:func:`hpx::make_ready_future_after`
:cpp:func:`hpx::make_exceptional_future`
:cpp:func:`hpx::when_all`
:cpp:func:`hpx::when_any`
:cpp:func:`hpx::make_exceptional_future` |p0159|_
:cpp:func:`hpx::when_all` |p0159|_
:cpp:func:`hpx::when_any` |p0159|_
:cpp:func:`hpx::when_some`
:cpp:func:`hpx::when_each`
:cpp:func:`hpx::wait_all`
Expand Down
8 changes: 5 additions & 3 deletions docs/sphinx/manual/building_hpx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -253,14 +253,14 @@ To build |hpx| under Windows 10 x64 with Visual Studio 2015:

.. code-block:: bash
bootstrap.bat
.\bootstrap.bat
This batch file will set up everything needed to create a successful build.
Now execute:

.. code-block:: bash
b2.exe link=shared variant=release,debug architecture=x86 address-model=64 threading=multi --build-type=complete install
.\b2.exe link=shared variant=release,debug architecture=x86 address-model=64 threading=multi --build-type=complete install
This command will start a (very long) build of all available Boost libraries.
Please, be patient.
Expand All @@ -285,12 +285,14 @@ To build |hpx| under Windows 10 x64 with Visual Studio 2015:
will build |hpx| packages out of the |hpx| source tree.

* Set three new environment variables (in CMake, not in Windows environment):
``BOOST_ROOT``, ``HWLOC_ROOT``, ``CMAKE_INSTALL_PREFIX``. The meaning of
``BOOST_ROOT``, ``HWLOC_ROOT``, ``ASIO_ROOT``, ``CMAKE_INSTALL_PREFIX``. The meaning of
these variables is as follows:

* ``BOOST_ROOT`` the |hpx| root directory of the unpacked Boost headers/cpp files.
* ``HWLOC_ROOT`` the |hpx| root directory of the unpacked Portable Hardware Locality
files.
* ``ASIO_ROOT`` the |hpx| root directory of the unpacked ASIO files. Alternatively use
``HPX_WITH_FETCH_ASIO`` with value ``True``.
* ``CMAKE_INSTALL_PREFIX`` the |hpx| root directory where the future builds of |hpx|
should be installed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1461,6 +1461,13 @@ The predefined command line options for any application using
Sed-style search and replace (``s/search/replace/``) used to transform host
names to the proper network interconnect.

.. option:: --hpx:force_ipv4

Network hostnames will be resolved to ipv4 adresses instead of using the
first resolved endpoint. This is especially useful on Windows where the
local hostname will resolve to an ipv6 adress while remote network hostnames
are commonly resolved to ipv4 adresses.

.. option:: --hpx:localities arg

The number of localities to wait for at application startup (default: ``1``).
Expand Down
2 changes: 2 additions & 0 deletions libs/core/algorithms/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ set(algorithms_headers
hpx/parallel/algorithms/detail/parallel_stable_sort.hpp
hpx/parallel/algorithms/detail/pivot.hpp
hpx/parallel/algorithms/detail/reduce.hpp
hpx/parallel/algorithms/detail/replace.hpp
hpx/parallel/algorithms/detail/rotate.hpp
hpx/parallel/algorithms/detail/sample_sort.hpp
hpx/parallel/algorithms/detail/search.hpp
Expand Down Expand Up @@ -168,6 +169,7 @@ set(algorithms_headers
hpx/parallel/datapar/loop.hpp
hpx/parallel/datapar/mismatch.hpp
hpx/parallel/datapar/reduce.hpp
hpx/parallel/datapar/replace.hpp
hpx/parallel/datapar/transfer.hpp
hpx/parallel/datapar/transform_loop.hpp
hpx/parallel/datapar/zip_iterator.hpp
Expand Down
Loading

0 comments on commit 9e5ac23

Please sign in to comment.