[arm-platforms:kvm-arm64/psci-suspend 7/13] htmldocs: Documentation/virt/kvm/api.rst:6049: (SEVERE/4) Title level inconsistent:
kernel test robot
lkp at intel.com
Thu May 5 12:05:09 PDT 2022
tree: https://git.kernel.org/pub/scm/linux/kernel/git/maz/arm-platforms.git kvm-arm64/psci-suspend
head: 582eb04e05ddd234ca32083c8457c6d409fd7b6a
commit: bfbab44568779e1682bc6f63688bb9c965f0e74a [7/13] KVM: arm64: Implement PSCI SYSTEM_SUSPEND
reproduce: make htmldocs
If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp at intel.com>
Note: the arm-platforms/kvm-arm64/psci-suspend HEAD 582eb04e05ddd234ca32083c8457c6d409fd7b6a builds fine.
It only hurts bisectability.
All errors (new ones prefixed by >>):
>> Documentation/virt/kvm/api.rst:6049: (SEVERE/4) Title level inconsistent:
vim +6049 Documentation/virt/kvm/api.rst
6031
6032 - KVM_SYSTEM_EVENT_SHUTDOWN -- the guest has requested a shutdown of the
6033 VM. Userspace is not obliged to honour this, and if it does honour
6034 this does not need to destroy the VM synchronously (ie it may call
6035 KVM_RUN again before shutdown finally occurs).
6036 - KVM_SYSTEM_EVENT_RESET -- the guest has requested a reset of the VM.
6037 As with SHUTDOWN, userspace can choose to ignore the request, or
6038 to schedule the reset to occur in the future and may call KVM_RUN again.
6039 - KVM_SYSTEM_EVENT_CRASH -- the guest crash occurred and the guest
6040 has requested a crash condition maintenance. Userspace can choose
6041 to ignore the request, or to gather VM memory core dump and/or
6042 reset/shutdown of the VM.
6043 - KVM_SYSTEM_EVENT_WAKEUP -- the exiting vCPU is in a suspended state and
6044 KVM has recognized a wakeup event. Userspace may honor this event by
6045 marking the exiting vCPU as runnable, or deny it and call KVM_RUN again.
6046 - KVM_SYSTEM_EVENT_SUSPEND -- the guest has requested a suspension of
6047 the VM.
6048
> 6049 For arm/arm64:
6050 ^^^^^^^^^^^^^^
6051
6052 KVM_SYSTEM_EVENT_SUSPEND exits are enabled with the
6053 KVM_CAP_ARM_SYSTEM_SUSPEND VM capability. If a guest invokes the PSCI
6054 SYSTEM_SUSPEND function, KVM will exit to userspace with this event
6055 type.
6056
6057 It is the sole responsibility of userspace to implement the PSCI
6058 SYSTEM_SUSPEND call according to ARM DEN0022D.b 5.19 "SYSTEM_SUSPEND".
6059 KVM does not change the vCPU's state before exiting to userspace, so
6060 the call parameters are left in-place in the vCPU registers.
6061
6062 Userspace is _required_ to take action for such an exit. It must
6063 either:
6064
6065 - Honor the guest request to suspend the VM. Userspace can request
6066 in-kernel emulation of suspension by setting the calling vCPU's
6067 state to KVM_MP_STATE_SUSPENDED. Userspace must configure the vCPU's
6068 state according to the parameters passed to the PSCI function when
6069 the calling vCPU is resumed. See ARM DEN0022D.b 5.19.1 "Intended use"
6070 for details on the function parameters.
6071
6072 - Deny the guest request to suspend the VM. See ARM DEN0022D.b 5.19.2
6073 "Caller responsibilities" for possible return values.
6074
--
0-DAY CI Kernel Test Service
https://01.org/lkp
More information about the linux-arm-kernel
mailing list