From 9e0dc830520a46f3cdc7e27ae980c582ba8b0105 Mon Sep 17 00:00:00 2001
From: Martin Lang <martin.lang@mpsd.mpg.de>
Date: Fri, 15 Dec 2023 09:50:09 +0100
Subject: [PATCH] Minor corrections in the documentation for the upcoming 24a
 release

---
 README.rst | 30 +++++++++++++++++-------------
 1 file changed, 17 insertions(+), 13 deletions(-)

diff --git a/README.rst b/README.rst
index f0f9016..42afae9 100644
--- a/README.rst
+++ b/README.rst
@@ -297,8 +297,8 @@ Development
 -----------
 Developers documentation is available at development.rst.
 
-Upcoming releases (for alpha testing)
--------------------------------------
+Upcoming release 24a (for alpha testing)
+----------------------------------------
 
 Work has started to provide newer toolchains and compiler versions. For these, the structure and layout of the modules has been modified compared to what is described above (the changes are experimentally and may change in the future, feedback is very welcome).
 
@@ -309,25 +309,29 @@ To use the new compilers on the HPC system run::
 
 You get access (as of Dec 2023) to ``gcc/12.2.0`` (easybuild toolchain foss2022b), ``gcc/12.3.0`` (easybuild toolchain foss2023a), and ``gcc/13.2.0`` (also via the toolchain gcc13 as easybuild did not yet release a toolchain with any gcc13 that we could mimic).
 
-When loading the toolchain metamodules (called ``toolchain/<easybuild version>|gcc<gcc version>``), you will load (ignoring internal dependencies)
+When loading the toolchain metamodules (called ``toolchain/<easybuild version>|gcc<gcc major version>``), you will load (ignoring internal dependencies)
 
 - gcc
-- openpi
+- openmpi
 - fftw
-- scalapack
 - openblas
+- scalapack
 
-Several additional octopus dependencies have also been compiled with all gcc versions. They can be loaded individually, we currently do not provide any metamodule for octopus dependencies. Please report any problems or missing modules, or difficulties loading modules that can come with or without MPI support.
-
-Each module sets an environment variable ``MPSD_<MODULE_NAME>_ROOT`` that can be used for configure.
+Several additional octopus dependencies have also been compiled with all gcc
+versions. They can be loaded individually, we currently do not provide any
+metamodule for octopus dependencies. Please report any problems or missing
+modules, or difficulties loading modules that can come with or without MPI
+support.
 
-Spack requires adding rpath in the linker options (``LDLIBRARY_PATH`` is not set [and should not be set]), more details are available at: https://computational-science.mpsd.mpg.de/docs/mpsd-hpc.html#setting-the-rpath-finding-libraries-at-runtime (also https://docs.mpcdf.mpg.de/faq/hpc_software.html#how-do-i-set-the-rpath ). The required syntax is ``-Wl,-rpath=/...``, e.g. for fftw in a Makefile::
+Each module sets an environment variable ``MPSD_<MODULE_NAME>_ROOT`` that can be used for configure and the rpath (see below).
 
-  LDFLAGS:= -lfftw3
-  LDFLAGS+=-Wl,-rpath=$(MPSD_FFTW_ROOT)/lib
+Spack requires adding rpath in the linker options (``LDLIBRARY_PATH`` is not set
+[and should not be set]), more details are available at:
+https://computational-science.mpsd.mpg.de/docs/mpsd-hpc.html#setting-the-rpath-finding-libraries-at-runtime
+(also https://docs.mpcdf.mpg.de/faq/hpc_software.html#how-do-i-set-the-rpath ).
 
-Setting the flags for all loaded modules should work via:::
+Setting the flags for all loaded modules should work via: ::
 
   export LDFLAGS=`echo ${LIBRARY_PATH:+:$LIBRARY_PATH} | sed -e 's/:/ -Wl,-rpath=/g'`
 
-*Note* An intel toolchain may also show up in the list. It might however not be functional yet so expect that loading that module might fail.
+*Note* An intel toolchain may at some point also show up in the list. It might however not be functional yet so expect that loading that module might fail.
-- 
GitLab