summaryrefslogtreecommitdiffstats
path: root/doc/legacy/handling-options.txt
diff options
context:
space:
mode:
authorVijay Bellur <vijay@gluster.com>2012-04-09 23:11:52 +0530
committerAnand Avati <avati@redhat.com>2012-04-11 10:25:56 -0700
commit076830c068fb39bbc3e863c89a4253cbea36357e (patch)
tree842884d8db9a40d5a53e5171c852a84daa8e0f65 /doc/legacy/handling-options.txt
parentdf8e2f53b70f4f49af70df308010dddfe5ca35ec (diff)
doc: Move outdated documentation to legacy
Change-Id: I0ceba9a993e8b1cdef4ff6a784bfd69c08107d88 BUG: 811311 Signed-off-by: Vijay Bellur <vijay@gluster.com> Reviewed-on: http://review.gluster.com/3116 Tested-by: Gluster Build System <jenkins@build.gluster.com> Reviewed-by: Amar Tumballi <amarts@redhat.com> Reviewed-by: Anand Avati <avati@redhat.com>
Diffstat (limited to 'doc/legacy/handling-options.txt')
-rw-r--r--doc/legacy/handling-options.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/legacy/handling-options.txt b/doc/legacy/handling-options.txt
new file mode 100644
index 000000000..9a3b2510a
--- /dev/null
+++ b/doc/legacy/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.
+