linux/Documentation/virtual/kvm
Dave Martin fe365b4ea6 KVM: Clarify KVM_{SET,GET}_ONE_REG error code documentation
The current error code documentation for KVM_GET_ONE_REG and
KVM_SET_ONE_REG could be read as implying that all architectures
implement these error codes, or that KVM guarantees which error
code is returned in a particular situation.

Because this is not really the case, this patch waters down the
documentation explicitly to remove such guarantees.

EPERM is marked as arm64-specific, since for now arm64 really is
the only architecture that yields this error code for the
finalization-required case.  Keeping this as a distinct error code
is useful however for debugging due to the statefulness of the API
in this instance.

No functional change.

Suggested-by: Andrew Jones <drjones@redhat.com>
Fixes: 395f562f2b ("KVM: Document errors for KVM_GET_ONE_REG and KVM_SET_ONE_REG")
Fixes: 50036ad06b ("KVM: arm64/sve: Document KVM API extensions for SVE")
Signed-off-by: Dave Martin <Dave.Martin@arm.com>
Reviewed-by: Andrew Jones <drjones@redhat.com>
Signed-off-by: Marc Zyngier <marc.zyngier@arm.com>
2019-04-18 17:14:02 +01:00
..
arm arm/arm64: KVM: Add PSCI version selection API 2018-04-20 16:32:23 +01:00
devices KVM: arm/arm64: vgic: Update documentation of the GIC devices wrt IIDR 2018-07-21 16:02:30 +01:00
amd-memory-encryption.rst Documentation/virtual/kvm: Update URL for AMD SEV API specification 2019-01-11 18:38:07 +01:00
api.txt KVM: Clarify KVM_{SET,GET}_ONE_REG error code documentation 2019-04-18 17:14:02 +01:00
cpuid.txt KVM: X86: Implement "send IPI" hypercall 2018-08-06 17:59:20 +02:00
halt-polling.txt KVM: Expose the initial start value in grow_halt_poll_ns() as a module parameter 2019-02-20 22:48:50 +01:00
hypercalls.txt KVM: X86: Implement "send IPI" hypercall 2018-08-06 17:59:20 +02:00
locking.txt kvm: x86: mmu: Update documentation for fast page fault mechanism 2017-01-09 14:46:12 +01:00
mmu.txt Revert "KVM: MMU: document fast invalidate all pages" 2019-02-20 22:48:39 +01:00
msr.txt KVM: x86: fix backward migration with async_PF 2018-02-24 01:43:48 +01:00
nested-vmx.txt KVM: docs: nVMX: Remove known limitations as they do not exist now 2018-06-01 19:18:28 +02:00
ppc-pv.txt Doc:kvm: Fix typo in Doc/virtual/kvm 2015-10-11 15:35:23 -06:00
review-checklist.txt docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
s390-diag.txt virtio-ccw: diag 500 may return a negative cookie 2019-03-06 11:19:33 -05:00
timekeeping.txt KVM: doc: Fix typo in doc/virtual/kvm 2013-12-31 17:24:54 -02:00
vcpu-requests.rst KVM: Add documentation for VCPU requests 2017-06-04 16:53:00 +02:00