diff --git a/doc/shared/sundials/Install.rst b/doc/shared/sundials/Install.rst index 6df1100650..a478507be1 100644 --- a/doc/shared/sundials/Install.rst +++ b/doc/shared/sundials/Install.rst @@ -33,17 +33,17 @@ SUNDIALS release compressed archives (``.tar.gz``) from the SUNDIALS The compressed archives allow for downloading of individual SUNDIALS packages. The name of the distribution archive is of the form -``SOLVER-7.1.0.tar.gz``, where ``SOLVER`` is one of: ``sundials``, ``cvode``, -``cvodes``, ``arkode``, ``ida``, ``idas``, or ``kinsol``, and ``7.1.0`` +``SOLVER-x.y.z.tar.gz``, where ``SOLVER`` is one of: ``sundials``, ``cvode``, +``cvodes``, ``arkode``, ``ida``, ``idas``, or ``kinsol``, and ``x.y.z`` represents the version number (of the SUNDIALS suite or of the individual solver). After downloading the relevant archives, uncompress and expand the sources, by running .. code-block:: bash - % tar -zxf SOLVER-7.1.0.tar.gz + % tar -zxf SOLVER-x.y.z.tar.gz -This will extract source files under a directory ``SOLVER-7.1.0``. +This will extract source files under a directory ``SOLVER-x.y.z``. Starting with version 2.6.0 of SUNDIALS, CMake is the only supported method of installation. The explanations of the installation procedure begin with a few @@ -51,7 +51,7 @@ common observations: #. The remainder of this chapter will follow these conventions: - ``SOLVERDIR`` is the directory ``SOLVER-7.1.0`` created above; i.e. the + ``SOLVERDIR`` is the directory ``SOLVER-x.y.z`` created above; i.e. the directory containing the SUNDIALS sources. ``BUILDDIR`` is the (temporary) directory under which SUNDIALS is built. @@ -684,7 +684,7 @@ illustration only. Default: "REF;OMP" - .. versionchanged: 7.1.0 + .. versionchanged:: 7.1.0 The ``DPCPP`` option was changed to ``SYCL`` to align with Ginkgo's naming convention. diff --git a/scripts/startReleaseCycle.sh b/scripts/startReleaseCycle.sh index ff9a393816..c565ba6859 100755 --- a/scripts/startReleaseCycle.sh +++ b/scripts/startReleaseCycle.sh @@ -117,3 +117,16 @@ do sedi 's/Changes to SUNDIALS.*/Changes to SUNDIALS in release X.Y.Z/I' \ "../doc/${pkg}/guide/source/Introduction.rst" done + +# ------------------------------------------------------------------------------ +# Update install guide +# ------------------------------------------------------------------------------ + +sedi "s/SOLVER-.*.gz/SOLVER-x.y.z.tar.gz/g" \ + ../doc/shared/sundials/Install.rst + +sedi "s/SOLVER-[0-9]\.[0-9]\.[0-9]/SOLVER-x.y.z/g" \ + ../doc/shared/sundials/Install.rst + +sedi "s/\`\`[0-9]\.[0-9]\.[0-9]\`\`/\`\`x.y.z\`\`/g" \ + ../doc/shared/sundials/Install.rst diff --git a/scripts/updateVersion.sh b/scripts/updateVersion.sh index 08a13693b9..056614bd12 100755 --- a/scripts/updateVersion.sh +++ b/scripts/updateVersion.sh @@ -373,6 +373,9 @@ sedi "s/x.y.z/${sun_ver}/gI" $fn fn="../doc/shared/Changelog.rst" sedi "s/x.y.z/${sun_ver}/gI" $fn +fn="../doc/shared/sundials/Install.rst" +sedi "s/x.y.z/${sun_ver}/gI" $fn + for fn in $(grep -Iirl "x.y.z" ../doc/shared/*) do sedi "s/x.y.z/${sun_ver}/gI" $fn