changeset 5656:c7dd42405e5a

added moin migration --help text (thanks to franklin)
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sun, 11 Apr 2010 18:55:31 +0200
parents 115278a9a95f
children 516d165c4bbf
files MoinMoin/script/migration/data.py
diffstat 1 files changed, 19 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/script/migration/data.py	Sun Apr 11 18:21:53 2010 +0200
+++ b/MoinMoin/script/migration/data.py	Sun Apr 11 18:55:31 2010 +0200
@@ -23,7 +23,25 @@
 from MoinMoin.script import MoinScript
 
 class PluginScript(MoinScript):
-    """ Migration script class """
+    """\
+Purpose:
+========
+This tool allow you to migrate data of pages to a newer version
+
+Detailed Instructions:
+======================
+General syntax: moin [options] migration data [migration-data-options]
+
+[options] usually should be:
+    --config-dir=/path/to/my/cfg/ --wiki-url=http://wiki.example.org/
+
+[migration-data-options] see below:
+    Please note:
+    * You must run this script as the owner of the wiki files.
+    * The file docs/UPDATE.html contains the general instructions
+      for upgrading a wiki.
+"""
+
 
     def __init__(self, argv, def_values):
         MoinScript.__init__(self, argv, def_values)