direct-io.hg

changeset 7588:b818029835de

The following patch adds a section for SHUTDOWN OPTIONS for the xmdomain.cfg
man page. It documents the new set of options introduced over the last few
weeks.

Signed-off-by: Sean Dague <sean@dague.net>
author kaf24@firebug.cl.cam.ac.uk
date Tue Nov 01 10:36:19 2005 +0100 (2005-11-01)
parents 07b5b3e2ff45
children 952945d2b68e
files docs/man/xmdomain.cfg.pod.5
line diff
     1.1 --- a/docs/man/xmdomain.cfg.pod.5	Tue Nov 01 10:34:34 2005 +0100
     1.2 +++ b/docs/man/xmdomain.cfg.pod.5	Tue Nov 01 10:36:19 2005 +0100
     1.3 @@ -72,6 +72,57 @@ A bare minimal config file example might
     1.4  
     1.5  =item I<builder>
     1.6  
     1.7 +=back 
     1.8 +
     1.9 +=head1 DOMAIN SHUTDOWN OPTIONS
    1.10 +
    1.11 +There are 3 options which control domain shutdown (both planned and
    1.12 +unplanned) under certain events.  The 3 events currently captured are:
    1.13 +
    1.14 +=over 4
    1.15 +
    1.16 +=item I<shutdown>
    1.17 +
    1.18 +Triggered on either an I<xm shutdown> or graceful shutdown from inside
    1.19 +the DomU.
    1.20 +
    1.21 +=item I<reboot>
    1.22 +
    1.23 +Triggered on either an I<xm reboot> or graceful reboot from inside the
    1.24 +DomU.
    1.25 +
    1.26 +=item I<crash>
    1.27 +
    1.28 +Triggered when a DomU goes to the crashed state for any reason.
    1.29 +
    1.30 +=back
    1.31 +
    1.32 +All of them take one of 4 valid states listed below.  
    1.33 +
    1.34 +=over 4
    1.35 +
    1.36 +=item I<destroy>
    1.37 +
    1.38 +The domain will be cleaned up completely.  No attempt at respawning
    1.39 +will occur.  This is what a typical shutdown would look like.
    1.40 +
    1.41 +=item I<restart>
    1.42 +
    1.43 +The domain will be restarted with the same name as the old domain.
    1.44 +This is what a typical reboot would look like.
    1.45 +
    1.46 +=item I<preserve>
    1.47 +
    1.48 +The domain will not be cleaned up at all.  This is often useful for
    1.49 +crash state domains which ensures that enough evidence is to debug the
    1.50 +real issue.
    1.51 +
    1.52 +=item I<rename-restart>
    1.53 +
    1.54 +The old domain will not be cleaned up, but will be renamed so a new
    1.55 +domain can be restarted in it's place.  (TODO: what does this mean for
    1.56 +resources?  What is the renamed name?)
    1.57 +
    1.58  =back
    1.59  
    1.60  =head1 SEE ALSO