Re: [PATCH 0/6] KVM: Documentation: Update document description for kvm_mmu_page and kvm_mmu_page_role

Zhi Wang
2023-06-19T09:01:03Z

On Sun, 18 Jun 2023 00:08:50 +0000
Mingwei Zhang <mizhang@google.com> wrote:

> When reading the KVM MMU documentation for nested virtualization, I feel
> that the description of kvm_mmu_page (and kvm_mmu_page_role) has been
> lagging for around 1-2 years. The descriptions for several fields in struct
> kvm_mmu_page and struct kvm_mmu_page_role are missing. So I think it might
> be good to add them to make it consistent with the current code.
>

This is so nice. A trivial comment, maybe refining the tittle of PATCH 1-6 a
bit: "Add the missing comment of xxxx into xxxx". It is a little bit confusing
by just looking at the titles at the first glance, more like some members are
missing, not the comments. :)

> Note that there are still some fields not added in this series:
> - kvm_mmu_page.nx_huge_page_disallowed
> - kvm_mmu_page.possible_nx_huge_page_link
> - kvm_mmu_page.hash_link
> - kvm_mmu_page.link
>
> For the above, I thought the description might be just better to be
> inlined or there is already good description inlined.
>
> Mingwei Zhang (6):
> KVM: Documentation: Add the missing guest_mode in kvm_mmu_page_role
> KVM: Documentation: Update the field name gfns in kvm_mmu_page
> KVM: Documentation: Add the missing ptep in kvm_mmu_page
> KVM: Documentation: Add the missing tdp_mmu_root_count into
> kvm_mmu_page
> KVM: Documentation: Add the missing mmu_valid_gen into kvm_mmu_page
> KVM: Documentation: Add the missing tdp_mmu_page into kvm_mmu_page
>
> Documentation/virt/kvm/x86/mmu.rst | 22 +++++++++++++++++++++-
> 1 file changed, 21 insertions(+), 1 deletion(-)
>
>
> base-commit: 265b97cbc22e0f67f79a71443b60dc1237ca5ee6