From e1475167ac60cc9dbf21db79367a44490a89e4a4 Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Sat, 10 Feb 2024 07:34:18 -0500 Subject: [PATCH 1/2] docs: Move "news" to "changelog" Move the list of changes for each release up under the release notes section, in a new subsection entitled "Changelog". This makes a little more sense than having a standalone "News" section, which was really just a throwback to the old standlaone NEWS text file, anyway. Signed-off-by: Jeff Squyres --- docs/Makefile.am | 4 +-- docs/index.rst | 1 - docs/news/index.rst | 25 --------------- docs/news/news-main.rst | 31 ------------------- docs/release-notes/changelog/index.rst | 17 ++++++++++ .../changelog/v1.x.rst} | 0 .../changelog/v2.x.rst} | 0 .../changelog/v3.0.x.rst} | 0 .../changelog/v3.1.x.rst} | 0 .../changelog/v4.0.x.rst} | 0 .../changelog/v4.1.x.rst} | 0 .../changelog/v5.0.x.rst} | 0 docs/release-notes/index.rst | 1 + 13 files changed, 20 insertions(+), 59 deletions(-) delete mode 100644 docs/news/index.rst delete mode 100644 docs/news/news-main.rst create mode 100644 docs/release-notes/changelog/index.rst rename docs/{news/news-v1.x.rst => release-notes/changelog/v1.x.rst} (100%) rename docs/{news/news-v2.x.rst => release-notes/changelog/v2.x.rst} (100%) rename docs/{news/news-v3.0.x.rst => release-notes/changelog/v3.0.x.rst} (100%) rename docs/{news/news-v3.1.x.rst => release-notes/changelog/v3.1.x.rst} (100%) rename docs/{news/news-v4.0.x.rst => release-notes/changelog/v4.0.x.rst} (100%) rename docs/{news/news-v4.1.x.rst => release-notes/changelog/v4.1.x.rst} (100%) rename docs/{news/news-v5.0.x.rst => release-notes/changelog/v5.0.x.rst} (100%) diff --git a/docs/Makefile.am b/docs/Makefile.am index 3abae38bc95..4c2905a55ab 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,7 +1,7 @@ # # Copyright (c) 2022 Cisco Systems, Inc. All rights reserved. +# Copyright (c) 2023-2024 Jeffrey M. Squyres. All rights reserved. # -# Copyright (c) 2023 Jeffrey M. Squyres. All rights reserved. # $COPYRIGHT$ # # Additional copyrights may follow @@ -41,6 +41,7 @@ IMAGE_SOURCE_FILES = \ RST_SOURCE_FILES = \ $(srcdir)/*.rst \ $(srcdir)/release-notes/*.rst \ + $(srcdir)/release-notes/changelog/*.rst \ $(srcdir)/installing-open-mpi/*.rst \ $(srcdir)/installing-open-mpi/*/*.rst \ $(srcdir)/features/*.rst \ @@ -51,7 +52,6 @@ RST_SOURCE_FILES = \ $(srcdir)/app-debug/*.rst \ $(srcdir)/developers/*.rst \ $(srcdir)/license/*.rst \ - $(srcdir)/news/*.rst \ $(srcdir)/man-openmpi/*.rst \ $(srcdir)/man-openmpi/man*/*.rst \ $(srcdir)/man-openshmem/*.rst \ diff --git a/docs/index.rst b/docs/index.rst index c339c213622..7662afee3d3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,6 +80,5 @@ Table of contents contributing license/index history - news/index man-openmpi/index man-openshmem/index diff --git a/docs/news/index.rst b/docs/news/index.rst deleted file mode 100644 index c7a2ece2222..00000000000 --- a/docs/news/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. Open MPI NEWS - - This page serves as a high level NEWS page which includes NEWS - from various Open MPI series - -News -==== - -This file contains the main features as well as overviews of specific -bug fixes (and other actions) for each version of Open MPI since -version 1.0. - -:ref:`search` - -.. toctree:: - :maxdepth: 1 - - news-main - news-v5.0.x - news-v4.1.x - news-v4.0.x - news-v3.1.x - news-v3.0.x - news-v2.x - news-v1.x diff --git a/docs/news/news-main.rst b/docs/news/news-main.rst deleted file mode 100644 index f57402b1d56..00000000000 --- a/docs/news/news-main.rst +++ /dev/null @@ -1,31 +0,0 @@ -Main updates (not on release branches yet) -========================================== - -This file generally contains all the updates for Open MPI that have -not yet appeared on a release branch. It reflects active development, -and is therefore a "loose" listing of features and changes. It is not -considered definitive. - -Open MPI version main ---------------------- - -.. admonition:: MPIR API has been removed - :class: warning - - As was announced in summer 2017, Open MPI has removed support of - MPIR-based tools beginning with the release of Open MPI v5.0.0. - - The new PRRTE based runtime environment supports PMIx-tools API - instead of the legacy MPIR API for debugging parallel jobs. - - see https://github.com/openpmix/mpir-to-pmix-guide for more - information - - -.. admonition:: zlib is suggested for better user experience - :class: note - - PMIx will optionally use zlib to compress large data streams. - This may result in shorter-than-normal startup times and - smaller memory footprints. It is recommended to install zlib - and zlib-devel for a better user experience. diff --git a/docs/release-notes/changelog/index.rst b/docs/release-notes/changelog/index.rst new file mode 100644 index 00000000000..6c298c930d1 --- /dev/null +++ b/docs/release-notes/changelog/index.rst @@ -0,0 +1,17 @@ +Changelog +========= + +This section contains the main features as well as overviews of +specific bug fixes (and other actions) for each version of Open MPI +since v1.0.0. + +.. toctree:: + :maxdepth: 1 + + v5.0.x + v4.1.x + v4.0.x + v3.1.x + v3.0.x + v2.x + v1.x diff --git a/docs/news/news-v1.x.rst b/docs/release-notes/changelog/v1.x.rst similarity index 100% rename from docs/news/news-v1.x.rst rename to docs/release-notes/changelog/v1.x.rst diff --git a/docs/news/news-v2.x.rst b/docs/release-notes/changelog/v2.x.rst similarity index 100% rename from docs/news/news-v2.x.rst rename to docs/release-notes/changelog/v2.x.rst diff --git a/docs/news/news-v3.0.x.rst b/docs/release-notes/changelog/v3.0.x.rst similarity index 100% rename from docs/news/news-v3.0.x.rst rename to docs/release-notes/changelog/v3.0.x.rst diff --git a/docs/news/news-v3.1.x.rst b/docs/release-notes/changelog/v3.1.x.rst similarity index 100% rename from docs/news/news-v3.1.x.rst rename to docs/release-notes/changelog/v3.1.x.rst diff --git a/docs/news/news-v4.0.x.rst b/docs/release-notes/changelog/v4.0.x.rst similarity index 100% rename from docs/news/news-v4.0.x.rst rename to docs/release-notes/changelog/v4.0.x.rst diff --git a/docs/news/news-v4.1.x.rst b/docs/release-notes/changelog/v4.1.x.rst similarity index 100% rename from docs/news/news-v4.1.x.rst rename to docs/release-notes/changelog/v4.1.x.rst diff --git a/docs/news/news-v5.0.x.rst b/docs/release-notes/changelog/v5.0.x.rst similarity index 100% rename from docs/news/news-v5.0.x.rst rename to docs/release-notes/changelog/v5.0.x.rst diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst index 11c002b39b0..8ddc9932d32 100644 --- a/docs/release-notes/index.rst +++ b/docs/release-notes/index.rst @@ -4,6 +4,7 @@ Release notes .. toctree:: :maxdepth: 1 + changelog/index general platform compilers From 8f0d24819fa6cd6bf2ce2b596dc98cfe9469a067 Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Sat, 10 Feb 2024 07:37:22 -0500 Subject: [PATCH 2/2] docs: Backport v5.0.1 and v5.0.2 changelog Copy the v5.0.1 and v5.0.2 changelog bullets back from the v5.0.x branch. Signed-off-by: Jeff Squyres --- docs/release-notes/changelog/v5.0.x.rst | 83 +++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/docs/release-notes/changelog/v5.0.x.rst b/docs/release-notes/changelog/v5.0.x.rst index b6ce469c9cd..71e95861392 100644 --- a/docs/release-notes/changelog/v5.0.x.rst +++ b/docs/release-notes/changelog/v5.0.x.rst @@ -4,6 +4,89 @@ Open MPI v5.0.x series This file contains all the NEWS updates for the Open MPI v5.0.x series, in reverse chronological order. +Open MPI version v5.0.2 +-------------------------- +:Date: 6 February 2024 + +- Internal PMIx and PRRTe versions: + + - PMIx (v4.2.8). Commit hash: ``d1c1ed0c2e64f19ad49291241a43630ea7fdce28``. + - PRRTE (v3.0.3). Commit hash: ``e383f5ad70c2633420d3425e9fb67e69b6bfd9c4``. + + .. note:: Due to the timing of Open MPI v5.0.2 release, the PMIx and PRRTE versions + that are internally bundled in the Open MPI distribution are the same + versions as in the Open MPI v5.0.1 release: PMIx v4.2.8 and PRRTE v3.0.3. + As a result, changes and bug fixes in newer PMIx and PRRTE releases are + not included in Open MPI v5.0.2, notably: + + PRRTE + + - Fix the map-by pe-list option + - Use pmix_path_nfs to detect shared file systems + - psets: fix some problems with PMIX_QUERY_PSET_MEMBERSHIP query. + PMIX_QUERY_PSET_MEMBERSHIP query bugfixes. + + PMIx + + - Restore default to enable-devel-check in Git repos + - Protect against empty envar definition for mca_base_param_files + - PMIx_Query_info: removed duplicated PMIX_RELEASE + - Do not add no-unused-parameter for non-devel-check builds + - Cast a few parameters when translating macros to functions + - Fix one more spot for "get" from rank undefined + - Fix "get" of key with undefined rank + - Resolve problem of stack variables and realloc + - Restore support for detecting shared file systems + - Fix broken link in README + +- Bugfixes and changes (in chronological order) + + - Fix the fs/lustre component build + - Fix a mtl/ofi multi-threaded race condition bug + - Add missing fortran profiling interfaces according to MPI 4.0 standard + - Allow 0-size data copy in opal/accelerator + - Fix a btl/ofi and mtl/ofi provider selection bug + - Properly initialize mca_rcache_base_module_t members + - Fix a singleton launch segfault + - Add GCC13 support with MacOS compatibility + +- Many thanks to Open MPI community including: + Erik Schnetter + +Open MPI version v5.0.1 +-------------------------- +:Date: 20 December 2023 + +- Internal PMIx and PRRTe versions: + + - PMIx (v4.2.8). Commit hash: ``d1c1ed0c2e64f19ad49291241a43630ea7fdce28``. + - PRRTE (v3.0.3). Commit hash: ``e383f5ad70c2633420d3425e9fb67e69b6bfd9c4``. + +- Bugfixes and changes (in chronological order) + + - Various documentation related updates and changes + - Fix a bunch of compiler warnings + - Sessions: fix a problem with fortran MPI_Session_get_nth_pset interface + - Correctly access the communicator name is MSGQ + - accelerator/cuda: fix bug in makefile.am preventing correct linkage + in non-standard location + - btlsmcuda: fix problem with makefile + - Fix rcache/gpusm and rcache/rgpsum + - Correctly handle attributes on MPI_COMM_WORLD. + - Minor memory leak fixes in: + btl/tcp, mca_base_framework, ob1 + - Fix static initialization of recursive mutexes + - Spack: fix for dlopen missing symbol problem + - opal/mca/accelerator: ROCm 6.0 incompatibility fix + - opal_var_dump_color_keys: fix an array overflow + - SHMEM_LOCKS: MCS implementation of SHMEM LOCKS + - configury: support flang-new + - Update processing of "display_map" info key + - dpm: update PMIX attribute + +- Many thanks to Open MPI community including: + Tony Curtis, David Edwards Linaro, Niv Shpak for their contribution. + Open MPI version 5.0.0 -------------------------- :Date: 25 October 2023