Skip to content

Commit

Permalink
Fix formatting, dates, etc. in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
msimberg committed Jan 27, 2021
1 parent dd15712 commit a2ca685
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/sphinx/contributing/release_procedure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 ``[email protected]`` of the
``hpx-users@stellar-group.org`` and ``[email protected]`` of the
availability of the release candidate. Ask users to test the candidate by
checking out the release candidate tag.

Expand Down Expand Up @@ -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, [email protected],
#. Announce the release on hpx-users@stellar-group.org, [email protected],
[email protected], [email protected], [email protected],
[email protected], the |hpx| Slack channel, the IRC channel, Sonia Sachs,
our list of external collaborators, isocpp.org, reddit.com, HPC Wire, Inside
Expand Down
11 changes: 6 additions & 5 deletions docs/sphinx/manual/building_hpx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/sphinx/releases.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/releases/whats_new_1_5_1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/releases/whats_new_1_6_0.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit a2ca685

Please sign in to comment.