Re: [PATCH v2] docs: clarify KVM related kernel parameters' descriptions

From: Jonathan Corbet
Date: Fri May 19 2023 - 10:56:52 EST


Yan-Jie Wang <yanjiewtw@xxxxxxxxx> writes:

> The descriptions of certain KVM related kernel parameters can be
> confusing. They state "Disable ...," which may make people think that
> setting them to 1 will disable the associated feature when in fact the
> opposite is true.
>
> This commit addresses this issue by revising the descriptions of these
> parameters by using "Control..." rather than "Enable/Disable...".
> 1==enabled or 0==disabled can be communicated by the description of
> default value such as "1 (enabled)" or "0 (disabled)".
>
> Also update the description of KVM's default value for kvm-intel.nested
> as it is enabled by default.
>
> Signed-off-by: Yan-Jie Wang <yanjiewtw@xxxxxxxxx>
> ---
> Changes in v2:
> - Revise the descriptions based on Sean's suggesstion.
> - Fix the wrong default value of kvm-intel.nested
> ---
> .../admin-guide/kernel-parameters.txt | 53 ++++++++++---------
> 1 file changed, 29 insertions(+), 24 deletions(-)

Applied, thanks.

jon