Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Yan-Jie Wang <yanjiewtw@gmail.com>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Cc:     Sean Christopherson <seanjc@google.com>,
        Paolo Bonzini <pbonzini@redhat.com>,
        Randy Dunlap <rdunlap@infradead.org>,
        Andre Przywara <andre.przywara@arm.com>,
        Avi Kivity <avi@redhat.com>,
        Yan-Jie Wang <yanjiewtw@gmail.com>,
        Ching-Chun Huang <jserv@ccns.ncku.edu.tw>, trivial@kernel.org,
        kvm@vger.kernel.org
Subject: Re: [PATCH v2] docs: clarify KVM related kernel parameters'
 descriptions
In-Reply-To: <20230503081530.19956-1-yanjiewtw@gmail.com>
References: <20230502112502.14859-1-yanjiewtw@gmail.com>
 <20230503081530.19956-1-yanjiewtw@gmail.com>
Date:   Fri, 19 May 2023 08:56:43 -0600
Message-ID: <87bkignzdg.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

Yan-Jie Wang <yanjiewtw@gmail.com> 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@gmail.com>
> ---
> 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