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 <[email protected]> Acked-by: Jonathan Ludlam <[email protected]> # HG changeset patch # User Jonathan Davies <[email protected]> # Date 1294409894 0 # Node ID 079d62fb17b81770b28342f3fc728a5f5e3ab3a9 # Parent 4560ba02da974d77d6afdcc36af5289d8e61b2d7 CA-49315: Unhide the IntelliCache field setters so they appear in the SDK 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 <[email protected]> Acked-by: Jonathan Ludlam <[email protected]> diff -r 4560ba02da97 -r 079d62fb17b8 ocaml/idl/datamodel.ml --- a/ocaml/idl/datamodel.ml Fri Jan 07 14:18:14 2011 +0000 +++ b/ocaml/idl/datamodel.ml Fri Jan 07 14:18:14 2011 +0000 @@ -4690,8 +4690,10 @@ ~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 @@ ~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 @@ ~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 ()
# HG changeset patch # User Jonathan Davies <[email protected]> # Date 1294409894 0 # Node ID 079d62fb17b81770b28342f3fc728a5f5e3ab3a9 # Parent 4560ba02da974d77d6afdcc36af5289d8e61b2d7 CA-49315: Unhide the IntelliCache field setters so they appear in the SDK 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 <[email protected]> Acked-by: Jonathan Ludlam <[email protected]> diff -r 4560ba02da97 -r 079d62fb17b8 ocaml/idl/datamodel.ml --- a/ocaml/idl/datamodel.ml Fri Jan 07 14:18:14 2011 +0000 +++ b/ocaml/idl/datamodel.ml Fri Jan 07 14:18:14 2011 +0000 @@ -4690,8 +4690,10 @@ ~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 @@ ~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 @@ ~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 ()
_______________________________________________ xen-api mailing list [email protected] http://lists.xensource.com/mailman/listinfo/xen-api
