documentation: add a chapter to the documentation describing how to

migrate to the new configuration format

Signed-off-by: Gordon Hecker <gh@emlix.com>

diff --git a/doc/manual/manual.text b/doc/manual/manual.text
index 44c777a54a64548a2eb539251f21b433f0266cdd..8ed065caee4e419ad8bee913e05d607791681cac 100644 (file)
--- a/doc/manual/manual.text
+++ b/doc/manual/manual.text
@@ -21,7 +21,7 @@ Content
 
 +   Advanced topics
  *   [building releases](release.html)
- *   [migrate from e2-2.1 to e2-2.2.x](migration.html)
+ *   [migrating to newer versions of e2factory](migration.html)
 
 +   FAQ
  *   [FAQ](faq.html)

diff --git a/doc/manual/migration.text b/doc/manual/migration.text
index 2ab422f7f5210dedf753025e8d236e56c6d0a75b..baa8c6aff829359ac0ebbbb1a543c139b42f80dd 100644 (file)
--- a/doc/manual/migration.text
+++ b/doc/manual/migration.text
@@ -1,8 +1,26 @@
-Migrate from e2-2.1 to e2-2.2.x
+Migrating to newer versions of e2factory
 -----------------------------
 
+### Migrating from e2factory-2.3.1 to e2factory-2.3.2 ###
 
-Migrating from e2-2.1 to e2-2.2.x requires the following steps:
+*   change the chroot configuration format according to the documentation
+    [chroot](chroot.html)
+*   change the licence configuration format according to the documentation
+    [licences](licences.html)
+*   in the chroot-, licence-, files source configuration the sha1 checksum
+    must be configured using the `sha1` attribute for files not located
+    on the `'.'` server.
+*   change the syntax version to `2_3_2` to acknowledge that you changed
+    the configuration.
+
+Change the syntax compatibility version and the version of your local tools
+
+    $ echo '2_3_2' >.e2/syntax
+    $ echo 'master e2factory-2.3.2' >.e2/e2version
+
+*   Do not forget to commit your changes.
+
+### Migrating from e2-2.1 to e2-2.2.x or up to e2factory-2.3.1 ###
 
 #### Prerequisites: Cleanup the project state: ####