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

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- 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>

+ <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>