KVM: Clarify KVM_{SET,GET}_ONE_REG error code documentation
authorDave Martin <Dave.Martin@arm.com>
Fri, 12 Apr 2019 11:59:47 +0000 (12:59 +0100)
committerMarc Zyngier <marc.zyngier@arm.com>
Thu, 18 Apr 2019 16:14:02 +0000 (17:14 +0100)
commitfe365b4ea6c0df3eb44d636c32c5210ae1e58364
tree68edebaa7fef3066294a6d730d3268c235216781
parent9df2d660c7f37aed7244ec0b920c0749dbb69167
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: 395f562f2b4c ("KVM: Document errors for KVM_GET_ONE_REG and KVM_SET_ONE_REG")
Fixes: 50036ad06b7f ("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>
Documentation/virtual/kvm/api.txt