From a2ca685bfbf93ca8efcb08603fc3d2d325ece665 Mon Sep 17 00:00:00 2001 From: Mikael Simberg Date: Wed, 27 Jan 2021 10:31:10 +0100 Subject: [PATCH] Fix formatting, dates, etc. in documentation --- docs/sphinx/contributing/release_procedure.rst | 4 ++-- docs/sphinx/manual/building_hpx.rst | 11 ++++++----- docs/sphinx/releases.rst | 4 +++- docs/sphinx/releases/whats_new_1_5_1.rst | 2 +- docs/sphinx/releases/whats_new_1_6_0.rst | 2 +- 5 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/sphinx/contributing/release_procedure.rst b/docs/sphinx/contributing/release_procedure.rst index 73f1822ecb1e..69dddda8bdd7 100644 --- a/docs/sphinx/contributing/release_procedure.rst +++ b/docs/sphinx/contributing/release_procedure.rst @@ -105,7 +105,7 @@ are completed to avoid confusion. The script requires that you have the |stellar| Group signing key. #. This step is not necessary for patch releases. Notify - ``hpx-users@stellar.cct.lsu.edu`` and ``stellar@cct.lsu.edu`` of the + ``hpx-users@stellar-group.org`` and ``stellar@cct.lsu.edu`` of the availability of the release candidate. Ask users to test the candidate by checking out the release candidate tag. @@ -170,7 +170,7 @@ are completed to avoid confusion. * Update version number in ``hpx/package.py`` and SHA256 to that of the new release -#. Announce the release on hpx-users@stellar.cct.lsu.edu, stellar@cct.lsu.edu, +#. Announce the release on hpx-users@stellar-group.org, stellar@cct.lsu.edu, allcct@cct.lsu.edu, faculty@csc.lsu.edu, faculty@ece.lsu.edu, xpress@crest.iu.edu, the |hpx| Slack channel, the IRC channel, Sonia Sachs, our list of external collaborators, isocpp.org, reddit.com, HPC Wire, Inside diff --git a/docs/sphinx/manual/building_hpx.rst b/docs/sphinx/manual/building_hpx.rst index f5a96a338180..28301f688228 100644 --- a/docs/sphinx/manual/building_hpx.rst +++ b/docs/sphinx/manual/building_hpx.rst @@ -982,11 +982,12 @@ How to build |hpx| under Windows 10 x64 with Visual Studio 2015 Alternatively, users could provide ``BOOST_LIBRARYDIR`` instead of ``BOOST_ROOT``; the difference is that ``BOOST_LIBRARYDIR`` should point to - the subdirectory inside Boost root where all the compiled DLLs/LIBs are. For example, - ``BOOST_LIBRARYDIR`` may point to the ``bin.v2`` subdirectory under the Boost rootdir. - It is important to keep the meanings of these two variables separated from each other: - ``BOOST_DIR`` points to the ROOT folder of the Boost library. ``BOOST_LIBRARYDIR`` - points to the subdir inside the Boost root folder where the compiled binaries are. + the subdirectory inside Boost root where all the compiled DLLs/LIBs are. For + example, ``BOOST_LIBRARYDIR`` may point to the ``bin.v2`` subdirectory under + the Boost rootdir. It is important to keep the meanings of these two variables + separated from each other: ``BOOST_DIR`` points to the ROOT folder of the + Boost library. ``BOOST_LIBRARYDIR`` points to the subdir inside the Boost root + folder where the compiled binaries are. * Click the 'Configure' button of CMake-GUI. You will be immediately presented with a small window where you can select the C++ compiler to be used within Visual diff --git a/docs/sphinx/releases.rst b/docs/sphinx/releases.rst index c9aca34dc863..008e1d38c558 100644 --- a/docs/sphinx/releases.rst +++ b/docs/sphinx/releases.rst @@ -1,5 +1,5 @@ .. - Copyright (C) 2018 Mikael Simberg + Copyright (C) 2018-2021 STE||AR Group SPDX-License-Identifier: BSL-1.0 Distributed under the Boost Software License, Version 1.0. (See accompanying @@ -14,6 +14,8 @@ Releases .. toctree:: :maxdepth: 1 + releases/whats_new_1_6_0 + releases/whats_new_1_5_1 releases/whats_new_1_5_0 releases/whats_new_1_4_1 releases/whats_new_1_4_0 diff --git a/docs/sphinx/releases/whats_new_1_5_1.rst b/docs/sphinx/releases/whats_new_1_5_1.rst index 6d6516653412..a6e15dafbcc2 100644 --- a/docs/sphinx/releases/whats_new_1_5_1.rst +++ b/docs/sphinx/releases/whats_new_1_5_1.rst @@ -17,7 +17,7 @@ General changes This is a patch release. It contains the following changes: * Remove restriction on suspending runtime with multiple localities, users are -now responsible for synchronizing work between localities before suspending. + now responsible for synchronizing work between localities before suspending. * Fixes several compilation problems and warnings. * Adds notes in the documentation explaining how to cite HPX. diff --git a/docs/sphinx/releases/whats_new_1_6_0.rst b/docs/sphinx/releases/whats_new_1_6_0.rst index a892b6fefa75..1ea6267adaf1 100644 --- a/docs/sphinx/releases/whats_new_1_6_0.rst +++ b/docs/sphinx/releases/whats_new_1_6_0.rst @@ -1,6 +1,6 @@ .. + Copyright (C) 2020-2021 ETH Zurich Copyright (C) 2007-2020 Hartmut Kaiser - Copyright (C) 2020 ETH Zurich SPDX-License-Identifier: BSL-1.0 Distributed under the Boost Software License, Version 1.0. (See accompanying