Upgrading existing Xuse installs
Please note: the upgrade tool is not guaranteed to function perfectly - please make sure you have backed up your existing work to a secure location before proceeding. The Xuse team does not hold any responsibility or liability for loss of data.
Now that the caveat is out of the way - Xuse does provide an upgrade tool. The tool should auto-detect the current model vresion you are working with (based on the model version of the requirements repository file) and apply the updates accordingly.
Command line users
- To upgrade your project please navigate to the root directory of your project (
PROJECT_BASEDIR). - Type the following command:
xuse upgrade - Xuse should upgrade the relevant files leaving copies of the originals in their original folder with an extension of
DSTAMP.TSTAMP.old, where DSTAMP and TSTAMP are the date timestamps at the time of the upgrade. - You should now be able to run the standard command of
to regerenate the documentation.
xuse xuse
Maven 2.x users
- To upgrade your project please navigate to the root directory of your project (
PROJECT_BASEDIR). - Type the following command:
mvn net.sourceforge.xuse:maven-xuse-m2-plugin:upgrade
- Xuse should upgrade the relevant files leaving copies of the originals in their original folder with an extension of
DSTAMP.TSTAMP.old, where DSTAMP and TSTAMP are the date timestamps at the time of the upgrade. - You should now be able to run the standard command of
to generate the documentation.
mvn net.sourceforge.xuse:maven-xuse-m2-plugin:xuse
Upgrade FAQ
Is the upgrade transactional?
No. Is is possible in some unforseen circumstances for the upgrade to fail part way through. Although no data should be lost it is still striongly recommended that you backup all your work prior to running the upgrade command.
Different files are at different model versions - will the upgrade routine still work?
Yes it will run and only upgrade those files that are at the older version (although it will appear that a new file has been created).
If the requirements repository is already in the new version it will not trigger the upgrade so you may need to manually edit the model-version attribute in this file such that it is same as the files that have not been upgraded. Once you have done this re-run the upgrade command.
My model files need upgrading but there Xuse gives a fatal error: 'Do not know how to upgrade from A to B'. Why is this not supported?
Please raise a support request and we will endeavour to support the upgrade path that you require.
