[PATCH v2] docs: note default for timer_mode in xl.cfg man

[PATCH v2] docs: note default for timer_mode in xl.cfg man

[Doug Goldstein]

There was no default documented but the header at
xen/include/public/hvm/params.h stated which the default was, so add it
to the docs.

Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
---
CC: Wei Liu <wei.liu2@citrix.com>
CC: Ian Jackson <ian.jackson@eu.citrix.com>
CC: Roger Pau Monné <roger.pau@citrix.com>
# George for the 4.8 and 4.9 backport
CC: George Dunlap <george.dunlap@eu.citrix.com>

change from v1:
- added same docs addition to HVM
---
 docs/man/xl.cfg.pod.5.in | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
index b7b91d8627..b6812a4033 100644
--- a/docs/man/xl.cfg.pod.5.in
+++ b/docs/man/xl.cfg.pod.5.in
@@ -1883,7 +1883,8 @@ Specifies the mode for Virtual Timers. The valid values are as follows:
 Delay for missed ticks. Do not advance a vCPU's time beyond the
 correct delivery time for interrupts that have been missed due to
 preemption. Deliver missed interrupts when the vCPU is rescheduled and
-advance the vCPU's virtual time stepwise for each one.
+advance the vCPU's virtual time stepwise for each one. This is the
+default.
 
 =item B<no_delay_for_missed_ticks>
 
@@ -2348,7 +2349,8 @@ Specifies the mode for Virtual Timers. The valid values are as follows:
 Delay for missed ticks. Do not advance a vCPU's time beyond the
 correct delivery time for interrupts that have been missed due to
 preemption. Deliver missed interrupts when the vCPU is rescheduled and
-advance the vCPU's virtual time stepwise for each one.
+advance the vCPU's virtual time stepwise for each one. This is the
+default.
 
 =item B<no_delay_for_missed_ticks>
 
-- 
2.13.6


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH v2] docs: note default for timer_mode in xl.cfg man

[Roger Pau Monné]

On Mon, Jan 15, 2018 at 08:45:51AM -0600, Doug Goldstein wrote:
> There was no default documented but the header at
> xen/include/public/hvm/params.h stated which the default was, so add it
> to the docs.

While looking at libxl code I've found the following (it's at the end
of libxl__domain_build_info_setdefault):

/* Configuration fields shared between PVH and HVM. */
if (b_info->type != LIBXL_DOMAIN_TYPE_PV) {
    if (libxl__timer_mode_is_default(&b_info->timer_mode))
        b_info->timer_mode = LIBXL_TIMER_MODE_NO_DELAY_FOR_MISSED_TICKS;
...

Which means that in libxl the default timer mode is
no_delay_for_missed_ticks instead of delay_for_missed_ticks, so I'm
afraid you will have to fixup the xl.cfg change below.

Thanks, Roger.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH v2] docs: note default for timer_mode in xl.cfg man

[Doug Goldstein]

[-- Attachment #1.1.1: Type: text/plain, Size: 1034 bytes --]

On 1/15/18 9:59 AM, Roger Pau Monné wrote:
> On Mon, Jan 15, 2018 at 08:45:51AM -0600, Doug Goldstein wrote:
>> There was no default documented but the header at
>> xen/include/public/hvm/params.h stated which the default was, so add it
>> to the docs.
> 
> While looking at libxl code I've found the following (it's at the end
> of libxl__domain_build_info_setdefault):
> 
> /* Configuration fields shared between PVH and HVM. */
> if (b_info->type != LIBXL_DOMAIN_TYPE_PV) {
>     if (libxl__timer_mode_is_default(&b_info->timer_mode))
>         b_info->timer_mode = LIBXL_TIMER_MODE_NO_DELAY_FOR_MISSED_TICKS;
> ...
> 
> Which means that in libxl the default timer mode is
> no_delay_for_missed_ticks instead of delay_for_missed_ticks, so I'm
> afraid you will have to fixup the xl.cfg change below.
> 
> Thanks, Roger.
> 

Well thank you for verifying this in the code instead of the headers
like I did. Follow up coming where I'll fix the header and the docs to
match the code.

-- 
Doug Goldstein


[-- Attachment #1.2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

[-- Attachment #2: Type: text/plain, Size: 157 bytes --]

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel