Re: [PATCH 4/7] KVM: x86/pmu: Add documentation for fixed ctr on PMU filter

From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Jinrong Liang <ljr.kernel@gmail.com>,
	Sean Christopherson <seanjc@google.com>
Cc: Like Xu <like.xu.linux@gmail.com>,
	Paolo Bonzini <pbonzini@redhat.com>,
	Jonathan Corbet <corbet@lwn.net>, Shuah Khan <shuah@kernel.org>,
	Aaron Lewis <aaronlewis@google.com>,
	David Matlack <dmatlack@google.com>,
	Vishal Annapurve <vannapurve@google.com>,
	Wanpeng Li <wanpengli@tencent.com>,
	Jinrong Liang <cloudliang@tencent.com>,
	linux-kselftest@vger.kernel.org, linux-doc@vger.kernel.org,
	kvm@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 4/7] KVM: x86/pmu: Add documentation for fixed ctr on PMU filter
Date: Sat, 15 Apr 2023 10:24:06 +0700	[thread overview]
Message-ID: <ZDoY1hOJfMwJk1SQ@debian.me> (raw)
In-Reply-To: <20230414110056.19665-5-cloudliang@tencent.com>

On Fri, Apr 14, 2023 at 07:00:53PM +0800, Jinrong Liang wrote:
> +Specifically, KVM follows the following pseudo-code when determining whether to
> +allow the guest FixCtr[i] to count its pre-defined fixed event:
> +
> +  FixCtr[i]_is_allowed = (action == ALLOW) && (bitmap & BIT(i)) ||
> +    (action == DENY) && !(bitmap & BIT(i));
> +  FixCtr[i]_is_denied = !FixCtr[i]_is_allowed;
> +

As kernel test robot has reported [1], you need to wrap the code above
in a code block:

---- >8 ----

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 036f5b1a39aff8..b5836767e0e76d 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -5126,7 +5126,7 @@ Via this API, KVM userspace can also control the behavior of the VM's fixed
 counters (if any) by configuring the "action" and "fixed_counter_bitmap" fields.
 
 Specifically, KVM follows the following pseudo-code when determining whether to
-allow the guest FixCtr[i] to count its pre-defined fixed event:
+allow the guest FixCtr[i] to count its pre-defined fixed event::
 
   FixCtr[i]_is_allowed = (action == ALLOW) && (bitmap & BIT(i)) ||
     (action == DENY) && !(bitmap & BIT(i));

Thanks.

[1]: https://lore.kernel.org/linux-doc/202304150850.rx4UDDsB-lkp@intel.com/

-- 
An old man doll... just what I always wanted! - Clara
