Re: [PATCH v2] KVM: x86/mmu: Clean up function comments for dirty logging APIs

[Huang, Kai]

On Fri, 2024-08-02 at 13:20 -0700, Sean Christopherson wrote:
> 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@xxxxxxxxxx>
> Signed-off-by: Sean Christopherson <seanjc@xxxxxxxxxx>
> 

Reviewed-by: Kai Huang <kai.huang@xxxxxxxxx>

[...]

>  
> -	/* Now handle 4K PTEs.  */
> +	/*
> +	 * (Re)Enable dirty logging for all 4KiB SPTEs that map the GFNs in
> +	 * mask.  If PML is enabled and the and the GFN doesn't need to be
				            ^
					double "and the"