]> xenbits.xensource.com Git - xcp/xen-api.git/commitdiff
CA-49315: Unhide the IntelliCache field setters so they appear in the SDK
authorJonathan Davies <jonathan.davies@citrix.com>
Wed, 26 Jan 2011 17:39:04 +0000 (17:39 +0000)
committerJonathan Davies <jonathan.davies@citrix.com>
Wed, 26 Jan 2011 17:39:04 +0000 (17:39 +0000)
This will also cause the functions to appear in the API docs, so add a bit more detail regarding the semantics of the fields.

Signed-off-by: Jonathan Davies <jonathan.davies@citrix.com>
Acked-by: Jonathan Ludlam <jonathan.ludlam@citrix.com>
ocaml/idl/datamodel.ml

index d08f150ece30f430c0473d42095ca8332c19b85e..ca8a61e71cae7cfd55e5fd535e87e098c7d8e45c 100644 (file)
@@ -4690,8 +4690,10 @@ let vdi_generate_config = call
    ~allowed_roles:_R_VM_ADMIN
    ()
 
-let on_boot = Enum ("on_boot", [ "reset", "The VDI will be reset to the state it was in at the last clone";
-"persist", "The VDIs contents are persistent" ])
+let on_boot = Enum ("on_boot", [
+   "reset", "When a VM containing this VDI is started, the contents of the VDI are reset to the state they were in when this flag was last set.";
+   "persist", "Standard behaviour.";
+   ])
 
 let vdi_set_on_boot = call
         ~name:"set_on_boot"
@@ -4699,8 +4701,7 @@ let vdi_set_on_boot = call
         ~in_product_since:rel_cowley
         ~params:[Ref _vdi, "self", "The VDI to modify";
                  on_boot, "value", "The value to set"]
-        ~doc:"Set the value of the on_boot parameter"
-        ~hide_from_docs:true
+        ~doc:"Set the value of the on_boot parameter. This value can only be changed when the VDI is not attached to a running VM."
         ~allowed_roles:_R_VM_ADMIN
         ()
 
@@ -4709,9 +4710,8 @@ let vdi_set_allow_caching = call
        ~in_oss_since:None
        ~in_product_since:rel_cowley
        ~params:[Ref _vdi, "self", "The VDI to modify";
-       Bool, "value", "The value to set"]
-       ~doc:"Set the value of the allow_caching parameter"
-       ~hide_from_docs:true
+                Bool, "value", "The value to set"]
+       ~doc:"Set the value of the allow_caching parameter. This value can only be changed when the VDI is not attached to a running VM. The caching behaviour is only affected by this flag for VHD-based VDIs that have one parent and no child VHDs. Moreover, caching only takes place when the host running the VM containing this VDI has a nominated SR for local caching."
        ~allowed_roles:_R_VM_ADMIN
        ()