diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 814e270fda..faa5e462d1 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -1016,11 +1016,32 @@
tickpolicy
- The tickpolicy 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 catchup sub-element. +

+ The tickpolicy attribute determines what + happens whens QEMU misses a deadline for injecting a + tick to the guest: +

+
+
delay
+
Continue to deliver ticks at the normal rate. + The guest time will be delayed due to the late + tick
+
catchup
+
Deliver ticks at a higher rate to catch up + with the missed tick. The guest time should + not be delayed once catchup is complete.
+
merge
+
Merge the missed tick(s) into one tick and + inject. The guest time may be delayed, depending + on how the OS reacts to the merging of ticks
+
discard
+
Throw away the missed tick(s) and continue + with future injection normally. The guest time + may be delayed, unless the OS has explicit + handling of lost ticks
+
+

If the policy is "catchup", there can be further details in + the catchup sub-element.

catchup
@@ -1030,6 +1051,9 @@ and limit.
+

+ Note that hypervisors are not required to support all policies across all time sources +

frequency