Resolve relative URLs from Updates.xml

This change allows you to use relative URLs to update repositories.
Absolute addresses are resolved relative to the current Updates.xml file is parsed.
Documentation added to ifw-updates.html page.

Change-Id: I5935355dfeee2236e9752cc2545c2d42da216f9e
Reviewed-by: Konstantin Podsvirov <konstantin@podsvirov.pro>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>

1 files changed, 39 insertions, 2 deletions

diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 7a667f912..af1089d1f 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -1256,6 +1256,14 @@
                  displayname="Example Repository" />
     \endcode
 
+    \c{url} will be used as a base url to resolve an \c{Updates.xml} file against.
+    If \c{url} is itself relative, it will be resolved against the base url of the current document.
+
+    \c{displayname} specifies how the repository should be named in the \gui Settings page
+    of the Maintenance Tool.
+
+    \c{name} and \c{password} optionally specify credentials for a protected repository.
+
     \section2 Removing Repositories
     To remove a repository, add a \c <Repository> child element to the
     \c <RepositoryUpdate> element with the following options:
@@ -1264,15 +1272,44 @@
     <Repository action="remove" url="http://www.example.com/repository" />
     \endcode
 
+    \c{url} must match exactly the url that is to be removed.
+
     \section2 Replacing Repositories
     To replace one repository with another, add a \c <Repository> child element to the
     \c <RepositoryUpdate> element with the following options:
 
     \code
-    <Repository action="replace" oldurl="http://www.example.com/repository"
-                newurl="http://www.example.com/newrepository" name="user" password="password"
+    <Repository action="replace" oldUrl="http://www.example.com/repository"
+                newUrl="http://www.example.com/newrepository" name="user" password="password"
                 displayname="New Example Repository" />
     \endcode
+
+    \c{oldUrl} must match exactly the url that is to be replaced.
+
+    \c{newUrl} must match exactly the url that is replace to.
+
+    \section1 Relocatable Repositories
+
+    Some projects contain multiple repositories. To create relocatable set
+    of repositories you should use relative paths.
+
+    So if generic repository available at address \c{http://www.example.com/repositories/generic}
+    and \c{Updates.xml} contains \c <Repository> element with the following options:
+
+    \code
+    <Repository action="add" url="../module" name="user" password="password"
+                 displayname="Module Repository" />
+    \endcode
+
+    Resolved address of added repository will be \c{http://www.example.com/repositories/module}.
+    So that the repository does not contain information about their absolute location.
+
+    If you want to change the address, you can simply copy a set of repositories as is.
+    It recommended for some time to maintain the old generic repository and replace addresses
+    as described above. You can also provide the updated installer with the new generic address.
+
+    You can use relative path for arguments \c url, \c oldUrl and \c newUrl at
+    \c <Repository> element.
 */
 
 /*!