Patchwork [v14,4/4] pvevent: add document to describe the usage

login
register
mail settings
Submitter Hu Tao
Date March 14, 2013, 8:15 a.m.
Message ID <cd27751136ea7d70486c8e6d23d937eea3631938.1363243596.git.hutao@cn.fujitsu.com>
Download mbox | patch
Permalink /patch/227477/
State New
Headers show

Comments

Hu Tao - March 14, 2013, 8:15 a.m.
Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
---
 docs/pvevent.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 docs/pvevent.txt
Paolo Bonzini - March 14, 2013, 8:45 a.m.
Il 14/03/2013 09:15, Hu Tao ha scritto:
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> ---
>  docs/pvevent.txt | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>  create mode 100644 docs/pvevent.txt
> 
> diff --git a/docs/pvevent.txt b/docs/pvevent.txt
> new file mode 100644
> index 0000000..749b87c
> --- /dev/null
> +++ b/docs/pvevent.txt
> @@ -0,0 +1,16 @@
> +PVEVENT DEVICE
> +==============
> +
> +pvevent device is a simulated ISA device, through which guest panic
> +event is sent to qemu, and an qmp event is generated. This allows
> +management apps(e.g. libvirt) to be notified and respond to the
> +event.
> +
> +pvevent device is defined with HID "MSFT0001".

Why MSFT0001?  Otherwise the series looks good.

Paolo

> +To use it, one will have to:
> +
> +1. add the device by specifying `-device pv-event' in the qemu command
> +   line.
> +
> +2. load pvevent device driver in guest OS.
>
Hu Tao - March 14, 2013, 9:35 a.m.
On Thu, Mar 14, 2013 at 09:45:30AM +0100, Paolo Bonzini wrote:
> Il 14/03/2013 09:15, Hu Tao ha scritto:
> > Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> > ---
> >  docs/pvevent.txt | 16 ++++++++++++++++
> >  1 file changed, 16 insertions(+)
> >  create mode 100644 docs/pvevent.txt
> > 
> > diff --git a/docs/pvevent.txt b/docs/pvevent.txt
> > new file mode 100644
> > index 0000000..749b87c
> > --- /dev/null
> > +++ b/docs/pvevent.txt
> > @@ -0,0 +1,16 @@
> > +PVEVENT DEVICE
> > +==============
> > +
> > +pvevent device is a simulated ISA device, through which guest panic
> > +event is sent to qemu, and an qmp event is generated. This allows
> > +management apps(e.g. libvirt) to be notified and respond to the
> > +event.
> > +
> > +pvevent device is defined with HID "MSFT0001".
> 
> Why MSFT0001?  Otherwise the series looks good.

Will change to QEMU0001.

> 
> Paolo
> 
> > +To use it, one will have to:
> > +
> > +1. add the device by specifying `-device pv-event' in the qemu command
> > +   line.
> > +
> > +2. load pvevent device driver in guest OS.
> >
Eric Blake - March 14, 2013, 8:35 p.m.
On 03/14/2013 02:15 AM, Hu Tao wrote:
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> ---
>  docs/pvevent.txt | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>  create mode 100644 docs/pvevent.txt
> 
> diff --git a/docs/pvevent.txt b/docs/pvevent.txt
> new file mode 100644
> index 0000000..749b87c
> --- /dev/null
> +++ b/docs/pvevent.txt
> @@ -0,0 +1,16 @@
> +PVEVENT DEVICE
> +==============
> +
> +pvevent device is a simulated ISA device, through which guest panic
> +event is sent to qemu, and an qmp event is generated. This allows

s/an qmp/a QMP/ - although mentioning _which_ event might be niceer.

> +management apps(e.g. libvirt) to be notified and respond to the

s/apps(/apps (/

> +event.
> +
> +pvevent device is defined with HID "MSFT0001".
> +
> +To use it, one will have to:
> +
> +1. add the device by specifying `-device pv-event' in the qemu command
> +   line.
> +
> +2. load pvevent device driver in guest OS.

Missing is a sentence stating that the management app then has the
option of waiting for GUEST_PANICKED events, and/or polling for
guest-panicked RunState, to learn when the pvevent device has fired a
panic event.

Patch

diff --git a/docs/pvevent.txt b/docs/pvevent.txt
new file mode 100644
index 0000000..749b87c
--- /dev/null
+++ b/docs/pvevent.txt
@@ -0,0 +1,16 @@ 
+PVEVENT DEVICE
+==============
+
+pvevent device is a simulated ISA device, through which guest panic
+event is sent to qemu, and an qmp event is generated. This allows
+management apps(e.g. libvirt) to be notified and respond to the
+event.
+
+pvevent device is defined with HID "MSFT0001".
+
+To use it, one will have to:
+
+1. add the device by specifying `-device pv-event' in the qemu command
+   line.
+
+2. load pvevent device driver in guest OS.