From 932fd1ddeca69fb93216715a81aec97fb6f9fec1 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Tue, 17 Sep 2024 01:20:26 +0200 Subject: [PATCH] doc: describe how to upgrade Modules in INSTALL Fixes #544 --- INSTALL.rst | 25 +++++++++++++++++++++++++ NEWS.rst | 1 + 2 files changed, 26 insertions(+) diff --git a/INSTALL.rst b/INSTALL.rst index 27495d2ba..51201f52b 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -286,6 +286,31 @@ To learn more about siteconfig and run-command files, see the also look at the available :ref:`setup recipes` to get concrete deployment examples of these files. +Upgrading +--------- + +In case you want to upgrade a pre-existing Modules installation, it is +suggested to: + +1. Backup configuration files stored in *etcdir* (like :file:`siteconfig.tcl` + or :file:`initrc`); +2. Remove previous Modules installation; +3. Install new Modules version; +4. Review specific configuration of previous installation and adapt + configuration files of new version. + +It is advised to look at the different documents describing changes and new +features appearing between versions. By reading these documents you will be +able to determine the specific configuration options to apply to satisfy your +use cases. + +* :ref:`changes` +* :ref:`NEWS` +* :ref:`MIGRATING` + +In case you install Modules with the :instopt:`--enable-versioning` option +set, you may be able to install a new version of Modules alongside existing +ones (if they also have been installed with this option set). Build and installation options ------------------------------ diff --git a/NEWS.rst b/NEWS.rst index a34bf4cb1..a35db42de 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -100,6 +100,7 @@ Modules 5.5.0 (not yet released) * Add PowerShell Core (``pwsh``) shell support. (fix issue #326 with contribution from Simon Lukas Märtens) * Lib: adapt Modules Tcl extension library to properly load on Tcl 9. +* Doc: describe how to upgrade Modules in :ref:`INSTALL`. (fix issue #544) .. warning:: Variant names are now fully checked instead of just verifying their first character. Only characters within the ``A-Za-z0-9_-`` range are