Changes between Version 6 and Version 7 of TolPackage

Timestamp:

Feb 8, 2016, 10:46:25 AM (9 years ago)

Author:

Pedro Gea

Comment:

--

TolPackage

@@ -21 +21 @@
 !TolPackage is a TOL '''module''' (part of TolCore) for the TOL-packages management: installation, updating and upgrading, loading, creation, etc.
 
+== Functionalities ==
+
+!TolPackage has different versions linked to the package design evolution and requirements (see [wiki:TolPackage#History History]).
+
+The main functionalities described below are available from !TolPackage version 2 onwards.
+
+=== Package installation ===
+
+A package is automatically installed the first time it is required ({{{#Require}}}). 
+
+{{{
+#!cpp
+#Require <package>;
+}}}
+
+However, an installation can be carried out manually via the {{{InstallPackage}}} function, indicating the
+identifier (name and version) of the package desired for installation:
+
+{{{
+#!cpp
+Real TolPackage:InstallPackage(<packageIdentifier>);
+}}}
+
+If you don't know the most recent version we can use the {{{InstallLastCompatible}}} function
+and simply indicate the package name:
+
+{{{
+#!cpp
+Real TolPackage:InstallLastCompatible(<packageName>);
+}}}
+
+=== Update and upgrade ===
+
+Periodically, new versions of a package are created. So, you need update and upgrade your packages to stay up to date.
+
+!TolPackage identifies two replacement mechanisms:
+
+ * A package update, consisting of the substitution of the package for another more recent one, which has the same version numbers.
+
+ * A package upgrade, consisting of the installation of a new version of the package. 
+   Note that the previous version is not uninstalled.
+
+A package update usually includes important corrections, since the reconstruction of a
+package with the same version discards the previous one.
+
+To update a package we can use the {{{Update}}} function, indicating the package name:
+{{{
+#!cpp
+Real TolPackage::Update(<packageName>);
+}}}
+
+We can also update all the packages we have installed using the {{{UpdateAll}}} function:
+{{{
+#!cpp
+Real TolPackage::UpdateAll(?);
+}}}
+
+A package upgrade is equally recommendable, as in many cases they include important advances
+in the implemented procedures and algorithms.
+
+To improve a unique package we can use the Upgrade function:
+{{{
+#!cpp
+Real TolPackage::Upgrade(<packageName>);
+}}}
+
+And in a similar way, the {{{UpgradeAll}}} function, to improve all of the installed packages:
+{{{
+#!cpp
+Real TolPackage::UpgradeAll(?);
+}}}
+
+=== Low version upgrade ===
+
+In case of you wish to upgrade the low-version (second version number) of a package maintaining the high-version as it is, you have {{{the LowUpgrade}}} function. It is called using the package name and the first version number (high-version number):
+{{{
+#!cpp
+Real TolPackage::LowUpgrade(<packageName.highVersion>);
+}}}
+
+Bear in mind that if you do not indicate a high-version when use {{{LowUpgrade}}}, an attempt would be made to upgrade
+the low-version of all of the installed high-versions.
+
+If you wish to obtain all of the upgrades for a package, you have the function {{{FullUpgrade}}} which joins calls to {{{Upgrade}}} and {{{LowUpgrade}}}:
+{{{
+#!cpp
+Real TolPackage::FullUpgrade(<packageName>);
+}}}
+
+You also have functions for low- or full-upgrade all installed packages: {{{LowUpgradeAll}}} and {{{FullUpgradeAll}}}.
 
 == History ==