public inbox for kvm@vger.kernel.org
 help / color / mirror / Atom feed
From: Yan-Jie Wang <yanjiewtw@gmail.com>
To: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>,
	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: [PATCH] docs: clarify KVM related kernel parameters' descriptions
Date: Tue,  2 May 2023 19:25:02 +0800	[thread overview]
Message-ID: <20230502112502.14859-1-yanjiewtw@gmail.com> (raw)

The descriptions of certain KVM related kernel parameters can be
ambiguous and confusing. They state 'Disable ...,' which implies that
setting them to 1 would disable the associated features or options,
when in fact the opposite is true.

This commit addresses this issue by revising the descriptions of these
parameters to make their intended behavior clear.

Signed-off-by: Yan-Jie Wang <yanjiewtw@gmail.com>
---
 Documentation/admin-guide/kernel-parameters.txt | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 9e5bab29685f..cc5abb3d54b9 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -2552,10 +2552,10 @@
 			on the ratio, such that a page is zapped after 1 hour on average.
 
 	kvm-amd.nested=	[KVM,AMD] Allow nested virtualization in KVM/SVM.
-			Default is 1 (enabled)
+			Default is 1 (allow)
 
-	kvm-amd.npt=	[KVM,AMD] Disable nested paging (virtualized MMU)
-			for all guests.
+	kvm-amd.npt=	[KVM,AMD] Enable nested paging (virtualized MMU)
+			for all guests on capable AMD chips.
 			Default is 1 (enabled) if in 64-bit or 32-bit PAE mode.
 
 	kvm-arm.mode=
@@ -2602,12 +2602,12 @@
 			Format: <integer>
 			Default: 5
 
-	kvm-intel.ept=	[KVM,Intel] Disable extended page tables
+	kvm-intel.ept=	[KVM,Intel] Enable extended page tables
 			(virtualized MMU) support on capable Intel chips.
 			Default is 1 (enabled)
 
 	kvm-intel.emulate_invalid_guest_state=
-			[KVM,Intel] Disable emulation of invalid guest state.
+			[KVM,Intel] Enable emulation of invalid guest state.
 			Ignored if kvm-intel.enable_unrestricted_guest=1, as
 			guest state is never invalid for unrestricted guests.
 			This param doesn't apply to nested guests (L2), as KVM
@@ -2615,7 +2615,7 @@
 			Default is 1 (enabled)
 
 	kvm-intel.flexpriority=
-			[KVM,Intel] Disable FlexPriority feature (TPR shadow).
+			[KVM,Intel] Enable FlexPriority feature (TPR shadow).
 			Default is 1 (enabled)
 
 	kvm-intel.nested=
@@ -2623,7 +2623,7 @@
 			Default is 0 (disabled)
 
 	kvm-intel.unrestricted_guest=
-			[KVM,Intel] Disable unrestricted guest feature
+			[KVM,Intel] Enable unrestricted guest feature
 			(virtualized real and unpaged mode) on capable
 			Intel chips. Default is 1 (enabled)
 
@@ -2639,7 +2639,7 @@
 
 			Default is cond (do L1 cache flush in specific instances)
 
-	kvm-intel.vpid=	[KVM,Intel] Disable Virtual Processor Identification
+	kvm-intel.vpid=	[KVM,Intel] Enable Virtual Processor Identification
 			feature (tagged TLBs) on capable Intel chips.
 			Default is 1 (enabled)
 

base-commit: 865fdb08197e657c59e74a35fa32362b12397f58
-- 
2.34.1


             reply	other threads:[~2023-05-02 11:26 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-02 11:25 Yan-Jie Wang [this message]
2023-05-02 17:12 ` [PATCH] docs: clarify KVM related kernel parameters' descriptions Sean Christopherson
2023-05-03  7:15   ` Yan-Jie Wang
2023-05-03  8:15 ` [PATCH v2] " Yan-Jie Wang
2023-05-19 14:56   ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230502112502.14859-1-yanjiewtw@gmail.com \
    --to=yanjiewtw@gmail.com \
    --cc=andre.przywara@arm.com \
    --cc=avi@redhat.com \
    --cc=corbet@lwn.net \
    --cc=jserv@ccns.ncku.edu.tw \
    --cc=kvm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pbonzini@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=seanjc@google.com \
    --cc=trivial@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox