[libvirt] [PATCH] Expand docs for timer tick policy

[Eric Blake]

On 03/26/2012 06:29 AM, Daniel P. Berrange wrote:
> From: "Daniel P. Berrange" <berrange at redhat.com>
> 
> ---
>  docs/formatdomain.html.in |   25 ++++++++++++++++++++-----
>  1 files changed, 20 insertions(+), 5 deletions(-)
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index 814e270..c2eabc5 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -1016,11 +1016,23 @@
>            </dd>
>            <dt><code>tickpolicy</code></dt>
>            <dd>
> -            The <code>tickpolicy</code> attribute determines how
> -            missed ticks in the guest are handled, and can be "delay",
> -            "catchup", "merge", or "discard".  If the policy is
> -            "catchup", there can be further details in
> -            the <code>catchup</code> sub-element.
> +            <p>
> +            The <code>tickpolicy</code> attribute determines what
> +            happens whens QEMU misses a deadline for injecting a
> +            tick to the guest:
> +            </p>
> +            <dl>
> +              <dt><code>delay</code></dt>
> +              <dd>Continue to deliver ticks at the normal rate. The guest time will be delayed due to the late tick</dd>

Long lines.  Can you please wrap them?

> +              <dt><code>catchup</code></dt>
> +              <dd>Deliver ticks at a higher rate to catchup with the missed tick. The guest time should not be delayed once catch is complete.</dd>

s/catchup/catch up/  s/catch is/catch up is/

ACK with those nits fixed.

-- 
Eric Blake   eblake at redhat.com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 620 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20120326/ceea0edb/attachment-0001.sig>