[PATCH 0/3] Documentation: KVM: add a place to document API quirks and (x86) CPU errata

Paolo Bonzini
2022-03-22T11:07:20Z

Reorganize Documentation/virt/kvm to be less x86-centric, and add a new
file to document the ways in which x86 emulation is "wrong". There are
surely many more, for now just add the skeleton. Please reply to this
message with things that you'd like to see documented.

While at it add also a section for places where the KVM API is bad or
returns wrong values. Please also include them in reply to this message
if you are interested in seeing them documented.

Paolo

Paolo Bonzini (3):
Documentation: KVM: add separate directories for architecture-specific
documentation
Documentation: KVM: add virtual CPU errata documentation
Documentation: KVM: add API issues section

Documentation/virt/kvm/api.rst | 46 +++++++++++++++++++
Documentation/virt/kvm/index.rst | 28 ++++-------
Documentation/virt/kvm/s390/index.rst | 12 +++++
.../virt/kvm/{ => s390}/s390-diag.rst | 0
.../virt/kvm/{ => s390}/s390-pv-boot.rst | 0
Documentation/virt/kvm/{ => s390}/s390-pv.rst | 0
.../kvm/{ => x86}/amd-memory-encryption.rst | 0
Documentation/virt/kvm/{ => x86}/cpuid.rst | 0
Documentation/virt/kvm/x86/errata.rst | 39 ++++++++++++++++
.../virt/kvm/{ => x86}/halt-polling.rst | 0
.../virt/kvm/{ => x86}/hypercalls.rst | 0
Documentation/virt/kvm/x86/index.rst | 19 ++++++++
Documentation/virt/kvm/{ => x86}/mmu.rst | 0
Documentation/virt/kvm/{ => x86}/msr.rst | 0
.../virt/kvm/{ => x86}/nested-vmx.rst | 0
.../kvm/{ => x86}/running-nested-guests.rst | 0
.../virt/kvm/{ => x86}/timekeeping.rst | 0
17 files changed, 124 insertions(+), 20 deletions(-)
create mode 100644 Documentation/virt/kvm/s390/index.rst
rename Documentation/virt/kvm/{ => s390}/s390-diag.rst (100%)
rename Documentation/virt/kvm/{ => s390}/s390-pv-boot.rst (100%)
rename Documentation/virt/kvm/{ => s390}/s390-pv.rst (100%)
rename Documentation/virt/kvm/{ => x86}/amd-memory-encryption.rst (100%)
rename Documentation/virt/kvm/{ => x86}/cpuid.rst (100%)
create mode 100644 Documentation/virt/kvm/x86/errata.rst
rename Documentation/virt/kvm/{ => x86}/halt-polling.rst (100%)
rename Documentation/virt/kvm/{ => x86}/hypercalls.rst (100%)
create mode 100644 Documentation/virt/kvm/x86/index.rst
rename Documentation/virt/kvm/{ => x86}/mmu.rst (100%)
rename Documentation/virt/kvm/{ => x86}/msr.rst (100%)
rename Documentation/virt/kvm/{ => x86}/nested-vmx.rst (100%)
rename Documentation/virt/kvm/{ => x86}/running-nested-guests.rst (100%)
rename Documentation/virt/kvm/{ => x86}/timekeeping.rst (100%)

--
2.35.1