]> www.infradead.org Git - users/jedix/linux-maple.git/commit
KVM: x86/mmu: Clean up function comments for dirty logging APIs
authorSean Christopherson <seanjc@google.com>
Fri, 2 Aug 2024 20:20:06 +0000 (13:20 -0700)
committerSean Christopherson <seanjc@google.com>
Thu, 22 Aug 2024 18:40:04 +0000 (11:40 -0700)
commitacf2923271ef3611ceab7004fc8798d3ba31b739
treed7899d21bfb2ab033ac7b21f465353dc16ecd458
parent47ac09b91befbb6a235ab620c32af719f8208399
KVM: x86/mmu: Clean up function comments for dirty logging APIs

Rework the function comment for kvm_arch_mmu_enable_log_dirty_pt_masked()
into the body of the function, as it has gotten a bit stale, is harder to
read without the code context, and is the last source of warnings for W=1
builds in KVM x86 due to using a kernel-doc comment without documenting
all parameters.

Opportunistically subsume the functions comments for
kvm_mmu_write_protect_pt_masked() and kvm_mmu_clear_dirty_pt_masked(), as
there is no value in regurgitating similar information at a higher level,
and capturing the differences between write-protection and PML-based dirty
logging is best done in a common location.

No functional change intended.

Cc: David Matlack <dmatlack@google.com>
Reviewed-by: Kai Huang <kai.huang@intel.com>
Reviewed-by: Pankaj Gupta <pankaj.gupta@amd.com>
Link: https://lore.kernel.org/r/20240802202006.340854-1-seanjc@google.com
Signed-off-by: Sean Christopherson <seanjc@google.com>
arch/x86/kvm/mmu/mmu.c