From 4c9f0af346d0940cd099a458ccff5561b6274f5d Mon Sep 17 00:00:00 2001 From: Paul Bauer Date: Thu, 22 Oct 2020 08:54:24 +0000 Subject: [PATCH] Prepare master for 2022 Makes sure that we have the proper split between master and release-2021 Change-Id: I40ac5699b45e8f7df7ceb26bda3d3476a635a939 --- cmake/gmxVersionInfo.cmake | 9 +++-- docs/CMakeLists.txt | 9 +++++ .../2021/major/deprecated-functionality.rst | 2 - docs/release-notes/2022/major/bugs-fixed.rst | 9 +++++ .../2022/major/deprecated-functionality.rst | 14 +++++++ docs/release-notes/2022/major/features.rst | 9 +++++ docs/release-notes/2022/major/highlights.rst | 22 +++++++++++ .../2022/major/miscellaneous.rst | 9 +++++ docs/release-notes/2022/major/performance.rst | 9 +++++ docs/release-notes/2022/major/portability.rst | 3 ++ .../2022/major/removed-functionality.rst | 9 +++++ docs/release-notes/2022/major/tools.rst | 9 +++++ docs/release-notes/index.rst | 37 ++++++++++++++----- 13 files changed, 135 insertions(+), 15 deletions(-) create mode 100644 docs/release-notes/2022/major/bugs-fixed.rst create mode 100644 docs/release-notes/2022/major/deprecated-functionality.rst create mode 100644 docs/release-notes/2022/major/features.rst create mode 100644 docs/release-notes/2022/major/highlights.rst create mode 100644 docs/release-notes/2022/major/miscellaneous.rst create mode 100644 docs/release-notes/2022/major/performance.rst create mode 100644 docs/release-notes/2022/major/portability.rst create mode 100644 docs/release-notes/2022/major/removed-functionality.rst create mode 100644 docs/release-notes/2022/major/tools.rst diff --git a/cmake/gmxVersionInfo.cmake b/cmake/gmxVersionInfo.cmake index 005ede6bc0..1f88249c73 100644 --- a/cmake/gmxVersionInfo.cmake +++ b/cmake/gmxVersionInfo.cmake @@ -60,6 +60,7 @@ # GROMACS 2019 4 # GROMACS 2020 5 # GROMACS 2021 6 +# GROMACS 2022 7 # LIBRARY_SOVERSION_MINOR so minor version for the built libraries. # Should be increased for each release that changes only the implementation. # In GROMACS, the typical policy is to increase it for each patch version @@ -197,13 +198,13 @@ # The GROMACS convention is that these are the version number of the next # release that is going to be made from this branch. -set(GMX_VERSION_MAJOR 2021) +set(GMX_VERSION_MAJOR 2022) set(GMX_VERSION_PATCH 0) # The suffix, on the other hand, is used mainly for betas and release # candidates, where it signifies the most recent such release from # this branch; it will be empty before the first such release, as well # as after the final release is out. -set(GMX_VERSION_SUFFIX "-beta1") +set(GMX_VERSION_SUFFIX "") # Conventionally with libtool, any ABI change must change the major # version number, the minor version number should change if it's just @@ -214,7 +215,7 @@ set(GMX_VERSION_SUFFIX "-beta1") # here. The important thing is to minimize the chance of third-party # code being able to dynamically link with a version of libgromacs # that might not work. -set(LIBRARY_SOVERSION_MAJOR 6) +set(LIBRARY_SOVERSION_MAJOR 7) set(LIBRARY_SOVERSION_MINOR 0) set(LIBRARY_VERSION ${LIBRARY_SOVERSION_MAJOR}.${LIBRARY_SOVERSION_MINOR}.0) @@ -256,7 +257,7 @@ if (NOT SOURCE_IS_SOURCE_DISTRIBUTION AND endif() set(REGRESSIONTEST_VERSION "${GMX_VERSION_STRING}") -set(REGRESSIONTEST_BRANCH "master") # TODO branch to 2021 +set(REGRESSIONTEST_BRANCH "master") # Run the regressiontests packaging job with the correct pakage # version string, and the release box checked, in order to have it # build the regressiontests tarball with all the right naming. The diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 4db45f30e0..662026c089 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -363,6 +363,15 @@ if (SPHINX_FOUND) how-to/visualize.rst install-guide/index.rst release-notes/index.rst + release-notes/2022/major/highlights.rst + release-notes/2022/major/features.rst + release-notes/2022/major/performance.rst + release-notes/2022/major/tools.rst + release-notes/2022/major/bugs-fixed.rst + release-notes/2022/major/removed-functionality.rst + release-notes/2022/major/deprecated-functionality.rst + release-notes/2022/major/portability.rst + release-notes/2022/major/miscellaneous.rst release-notes/2021/major/highlights.rst release-notes/2021/major/features.rst release-notes/2021/major/performance.rst diff --git a/docs/release-notes/2021/major/deprecated-functionality.rst b/docs/release-notes/2021/major/deprecated-functionality.rst index bad48892c0..d2348ec3a9 100644 --- a/docs/release-notes/2021/major/deprecated-functionality.rst +++ b/docs/release-notes/2021/major/deprecated-functionality.rst @@ -1,5 +1,3 @@ -.. _anticipated-changes: - .. Note to developers! Please use """"""" to underline the individual entries for fixed issues in the subfolders, otherwise the formatting on the webpage is messed up. diff --git a/docs/release-notes/2022/major/bugs-fixed.rst b/docs/release-notes/2022/major/bugs-fixed.rst new file mode 100644 index 0000000000..32793b8aaf --- /dev/null +++ b/docs/release-notes/2022/major/bugs-fixed.rst @@ -0,0 +1,9 @@ +Bugs fixed +^^^^^^^^^^ + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! + diff --git a/docs/release-notes/2022/major/deprecated-functionality.rst b/docs/release-notes/2022/major/deprecated-functionality.rst new file mode 100644 index 0000000000..1a7bff774f --- /dev/null +++ b/docs/release-notes/2022/major/deprecated-functionality.rst @@ -0,0 +1,14 @@ +.. _anticipated-changes: + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! + +Changes anticipated to |Gromacs| 2022 functionality +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Functionality deprecated in |Gromacs| 2022 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + diff --git a/docs/release-notes/2022/major/features.rst b/docs/release-notes/2022/major/features.rst new file mode 100644 index 0000000000..5626dc8d54 --- /dev/null +++ b/docs/release-notes/2022/major/features.rst @@ -0,0 +1,9 @@ +New and improved features +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! + diff --git a/docs/release-notes/2022/major/highlights.rst b/docs/release-notes/2022/major/highlights.rst new file mode 100644 index 0000000000..bf79671277 --- /dev/null +++ b/docs/release-notes/2022/major/highlights.rst @@ -0,0 +1,22 @@ +Highlights +^^^^^^^^^^ + +|Gromacs| 2022 was released on INSERT DATE HERE. Patch releases may +have been made since then, please use the updated versions! Here are +some highlights of what you can expect, along with more detail in the +links below! + +As always, we've got several useful performance improvements, with or +without GPUs, all enabled and automated by default. In addition, +several new features are available for running simulations. We are extremely +interested in your feedback on how well the new release works on your +simulations and hardware. The new features are: + +* Cool quotes music play list + + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! diff --git a/docs/release-notes/2022/major/miscellaneous.rst b/docs/release-notes/2022/major/miscellaneous.rst new file mode 100644 index 0000000000..1a242e3446 --- /dev/null +++ b/docs/release-notes/2022/major/miscellaneous.rst @@ -0,0 +1,9 @@ +Miscellaneous +^^^^^^^^^^^^^ + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! + diff --git a/docs/release-notes/2022/major/performance.rst b/docs/release-notes/2022/major/performance.rst new file mode 100644 index 0000000000..b4f7529794 --- /dev/null +++ b/docs/release-notes/2022/major/performance.rst @@ -0,0 +1,9 @@ +Performance improvements +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! + diff --git a/docs/release-notes/2022/major/portability.rst b/docs/release-notes/2022/major/portability.rst new file mode 100644 index 0000000000..aa938eb2aa --- /dev/null +++ b/docs/release-notes/2022/major/portability.rst @@ -0,0 +1,3 @@ +Portability +^^^^^^^^^^^ + diff --git a/docs/release-notes/2022/major/removed-functionality.rst b/docs/release-notes/2022/major/removed-functionality.rst new file mode 100644 index 0000000000..4b1b189f6c --- /dev/null +++ b/docs/release-notes/2022/major/removed-functionality.rst @@ -0,0 +1,9 @@ +Removed functionality +^^^^^^^^^^^^^^^^^^^^^ + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! + diff --git a/docs/release-notes/2022/major/tools.rst b/docs/release-notes/2022/major/tools.rst new file mode 100644 index 0000000000..32a358848e --- /dev/null +++ b/docs/release-notes/2022/major/tools.rst @@ -0,0 +1,9 @@ +Improvements to |Gromacs| tools +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. Note to developers! + Please use """"""" to underline the individual entries for fixed issues in the subfolders, + otherwise the formatting on the webpage is messed up. + Also, please use the syntax :issue:`number` to reference issues on GitLab, without the + a space between the colon and number! + diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst index dfb12c7e5a..6915178928 100644 --- a/docs/release-notes/index.rst +++ b/docs/release-notes/index.rst @@ -8,19 +8,19 @@ releases of |Gromacs|. Major releases contain changes to the functionality supported, whereas patch releases contain only fixes for issues identified in the corresponding major releases. -Two versions of |Gromacs| are under active maintenance, the 2021 -series and the 2020 series. In the latter, only highly conservative +Two versions of |Gromacs| are under active maintenance, the 2022 +series and the 2021 series. In the latter, only highly conservative fixes will be made, and only to address issues that affect scientific correctness. Naturally, some of those releases will be made after the -year 2020 ends, but we keep 2019 in the name so users understand how +year 2021 ends, but we keep 2021 in the name so users understand how up to date their version is. Such fixes will also be incorporated into -the 2021 release series, as appropriate. Around the time the 2022 -release is made, the 2020 series will no longer be maintained. +the 2022 release series, as appropriate. Around the time the 2023 +release is made, the 2021 series will no longer be maintained. Where issue numbers are reported in these release notes, more details can be found at https://gitlab.com/gromacs/gromacs/-/issues at that issue number. -|Gromacs| 2021 series +|Gromacs| 2022 series --------------------- .. todolist:: @@ -28,6 +28,26 @@ can be found at https://gitlab.com/gromacs/gromacs/-/issues at that issue number Major release ^^^^^^^^^^^^^ +.. toctree:: + :maxdepth: 1 + + 2022/major/highlights + 2022/major/features + 2022/major/performance + 2022/major/tools + 2022/major/bugs-fixed + 2022/major/deprecated-functionality + 2022/major/removed-functionality + 2022/major/portability + 2022/major/miscellaneous + + +|Gromacs| 2021 series +--------------------- + +Major release +^^^^^^^^^^^^^ + .. toctree:: :maxdepth: 1 @@ -41,6 +61,8 @@ Major release 2021/major/portability 2021/major/miscellaneous +Older (unmaintained) |Gromacs| series +------------------------------------------------------- |Gromacs| 2020 series --------------------- @@ -106,9 +128,6 @@ Major release 2019/major/portability 2019/major/miscellaneous -Older (unmaintained) |Gromacs| series -------------------------------------------------------- - |Gromacs| 2018 series --------------------- -- 2.22.0