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