Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix install guide versions #633

Merged
merged 4 commits into from
Jan 7, 2025
Merged

Docs: Fix install guide versions #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a8ebb88
fix typo
gardner48 Dec 26, 2024
87a6f19
udate versions in install guide for next release
gardner48 Dec 26, 2024
4d571c9
update x.y.z in install guide
gardner48 Dec 26, 2024
21d1ece
update install guide versions
gardner48 Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/shared/sundials/Install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,25 @@ 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
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.
Expand Down Expand Up @@ -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.

Expand Down
13 changes: 13 additions & 0 deletions scripts/startReleaseCycle.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 3 additions & 0 deletions scripts/updateVersion.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading