Allow the entire backup run to be halted by an action (Closes: #455836)

[matthijs/upstream/backupninja.git] / README

diff --git a/README b/README
index 849fe3ab96bddb086a67d2fc53f83180fbfcf887..03d96fe931ea217149793c53f7ab97b2c8ab4002 100644 (file)
--- a/README
+++ b/README
@@ -218,13 +218,15 @@ VSERVERS
 ========
 
 If you are using Linux-Vservers (http://linux-vserver.org/) there are some
-special capabilities that different handlers have to make vserver backups easier.
+special capabilities that different handlers have to make vserver 
+backups easier.
+
 Set the variable "vservers" to be "yes" in /etc/backupninja.conf and see the
 example configuration files for each handler to configure the vserver specific
 variables.
 
-Additional vserver variables that can be configured in /etc/backupninja.conf. but
-probably don't need to be changed:
+Additional vserver variables that can be configured in /etc/backupninja.conf, 
+but they probably don't need to be changed:
 
 VSERVERINFO (default: /usr/sbin/vserver-info)
 VSERVER (default: /usr/sbin/vserver)
@@ -251,6 +253,11 @@ To add an additional 'wizard' to ninjahelper, follow these steps:
          ... do work here ...
        }
 
-(3) check the examples of the included helpers to see how they are
-    written. The dialog functions are defined in easydialog.sh.
+(3) look at the existing helpers to see how they are written. Try to re-use
+    functions, such as the dialog functions that are defined in easydialog.sh,
+    or the vserver functions defined in lib/vserver.
 
+(4) test, re-test, and test again. Try to break the helper by going backwards,
+    try to think like someone who has no idea how to configure your handler
+    would think, try to make your helper as simple as possible. Walk like a cat,
+    become your shadow, don't let your senses betray you.