ia64/xen-unstable

changeset 13718:090079c988d1

Update doc-comments.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Mon Jan 29 12:53:18 2007 +0000 (2007-01-29)
parents 66dda30190a2
children f7b6ce00426b
files tools/libxen/include/xen_vm.h
line diff
     1.1 --- a/tools/libxen/include/xen_vm.h	Mon Jan 29 12:19:40 2007 +0000
     1.2 +++ b/tools/libxen/include/xen_vm.h	Mon Jan 29 12:53:18 2007 +0000
     1.3 @@ -51,7 +51,10 @@
     1.4   * PV/ramdisk, PV/args and PV/bootloader_args will be passed to the bootloader
     1.5   * unmodified, and interpretation of those fields is then specific to the
     1.6   * bootloader itself, including the possibility that the bootloader will
     1.7 - * ignore some or all of those given values.
     1.8 + * ignore some or all of those given values. Finally the paths of all bootable
     1.9 + * disks are added to the bootloader commandline (a disk is bootable if its
    1.10 + * VBD has the bootable flag set). There may be zero, one or many bootable
    1.11 + * disks; the bootloader decides which disk (if any) to boot from.
    1.12   * 
    1.13   * If the bootloader is pygrub, then the menu.lst is parsed if present in the
    1.14   * guest's filesystem, otherwise the specified kernel and ramdisk are used, or
    1.15 @@ -846,6 +849,8 @@ xen_vm_unpause(xen_session *session, xen
    1.16   * 
    1.17   * Once shutdown has been completed perform poweroff action specified in guest
    1.18   * configuration.
    1.19 + * 
    1.20 + * This can only be called when the specified VM is in the Running state.
    1.21   */
    1.22  extern bool
    1.23  xen_vm_clean_shutdown(xen_session *session, xen_vm vm);
    1.24 @@ -857,6 +862,8 @@ xen_vm_clean_shutdown(xen_session *sessi
    1.25   * 
    1.26   * Once shutdown has been completed perform reboot action specified in guest
    1.27   * configuration.
    1.28 + * 
    1.29 + * This can only be called when the specified VM is in the Running state.
    1.30   */
    1.31  extern bool
    1.32  xen_vm_clean_reboot(xen_session *session, xen_vm vm);
    1.33 @@ -879,14 +886,16 @@ xen_vm_hard_reboot(xen_session *session,
    1.34  
    1.35  
    1.36  /**
    1.37 - * Suspend the specified VM to disk.
    1.38 + * Suspend the specified VM to disk.  This can only be called when the
    1.39 + * specified VM is in the Running state.
    1.40   */
    1.41  extern bool
    1.42  xen_vm_suspend(xen_session *session, xen_vm vm);
    1.43  
    1.44  
    1.45  /**
    1.46 - * Awaken the specified VM and resume it.
    1.47 + * Awaken the specified VM and resume it.  This can only be called when
    1.48 + * the specified VM is in the Suspended state.
    1.49   */
    1.50  extern bool
    1.51  xen_vm_resume(xen_session *session, xen_vm vm, bool start_paused);