summaryrefslogtreecommitdiffstats
path: root/doc/handling-options.txt
diff options
context:
space:
mode:
authorVikas Gorur <vikas@zresearch.com>2009-02-18 17:36:07 +0530
committerVikas Gorur <vikas@zresearch.com>2009-02-18 17:36:07 +0530
commit77adf4cd648dce41f89469dd185deec6b6b53a0b (patch)
tree02e155a5753b398ee572b45793f889b538efab6b /doc/handling-options.txt
parentf3b2e6580e5663292ee113c741343c8a43ee133f (diff)
Added all files
Diffstat (limited to 'doc/handling-options.txt')
-rw-r--r--doc/handling-options.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/handling-options.txt b/doc/handling-options.txt
new file mode 100644
index 0000000..cac1fe9
--- /dev/null
+++ b/doc/handling-options.txt
@@ -0,0 +1,13 @@
+
+How to add a new option to a given volume ?
+===========================================
+
+* Add a entry in 'struct volume_options options[]' with your key, what is
+ the type of the 'key', etc.
+
+* The 'key' and corresponding 'value' given for the same by user are validated
+ before calling init() of the translator/transport/scheduler/auth-module.
+
+* Once the complete init() is successful, user will get a warning if he has
+ given a 'key' which is not defined in these modules.
+