Re: [PATCH for-4.21] fix xl.cfg docs to correct viridian defaults list

[Andrew Cooper <andrew.cooper3@xxxxxxxxxx>]

On 07/11/2025 7:23 pm, James Dingwall wrote:
> Hi,
>
> I was trying to work out why this would cause my Windows 10 guest to hang
> when it should have been equivalent to ['defaults'] or 1.
>
> viridian = ['base', 'freq', 'apic_assist', 'crash_ctl', 'no_vp_limit', 
> 'cpu_hotplug', 'time_ref_count', 'stimer']
>
> Checking the libxl sources show that in fact the defaults are:
>
>     if (libxl_defbool_val(info->u.hvm.viridian)) {
>         /* Enable defaults */
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_BASE);
>         libxl_bitmap_set(&enlightenments, LIBXL_VIRIDIAN_ENLIGHTENMENT_FREQ);
>         libxl_bitmap_set(&enlightenments, 
> LIBXL_VIRIDIAN_ENLIGHTENMENT_TIME_REF_COUNT);
>         libxl_bitmap_set(&enlightenments, 
> LIBXL_VIRIDIAN_ENLIGHTENMENT_APIC_ASSIST);
>         libxl_bitmap_set(&enlightenments, 
> LIBXL_VIRIDIAN_ENLIGHTENMENT_CRASH_CTL);
>         libxl_bitmap_set(&enlightenments, 
> LIBXL_VIRIDIAN_ENLIGHTENMENT_NO_VP_LIMIT);
>         libxl_bitmap_set(&enlightenments, 
> LIBXL_VIRIDIAN_ENLIGHTENMENT_CPU_HOTPLUG);
>     }
>
> LIBXL_VIRIDIAN_ENLIGHTENMENT_STIMER was removed as a default enlightement in
> e83077a3d11072708a5c38fa09fa9d011914e2a1 but the docs were not kept aligned.

Hmm, indeed.

For the patch, Reviewed-by: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>

It should have a fixes tag, but I can fix that on commit.

CC'ing Oleksii.  This is a docs fix should be considered for 4.21 at
this juncture.

~Andrew