[PATCH] docs/virt: add a blank line and some - to kvm api

[PATCH] docs/virt: add a blank line and some - to kvm api

[Yanteng Si]

Since 0e691ee7b5034 ("KVM:Documentation: Fix KVM_CAP_ENFORCE_PV_FEATURE_CPUID name") which
introduced awarning:

/home/siyanteng/mainline/linux/Documentation/virt/kvm/api.rst:6046: WARNING: Literal block ends without a blank line; unexpected unindent.
/home/siyanteng/mainline/linux/Documentation/virt/kvm/api.rst:7296: WARNING: Title underline too short.

8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
-----------------------------
/home/siyanteng/mainline/linux/Documentation/virt/kvm/api.rst:7296: WARNING: Title underline too short.

8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
-----------------------------

Add 8 "-" for (8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID)
Add a blank line.

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
---
 Documentation/virt/kvm/api.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index aeeb071c7688..a77c4533821f 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6043,6 +6043,7 @@ Valid values for 'type' are:
 			unsigned long args[6];
 			unsigned long ret[2];
 		} riscv_sbi;
+
 If exit reason is KVM_EXIT_RISCV_SBI then it indicates that the VCPU has
 done a SBI call which is not handled by KVM RISC-V kernel module. The details
 of the SBI call are available in 'riscv_sbi' member of kvm_run structure. The
@@ -7293,7 +7294,7 @@ trap and emulate MSRs that are outside of the scope of KVM as well as
 limit the attack surface on KVM's MSR emulation code.
 
 8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
------------------------------
+-------------------------------------
 
 Architectures: x86
 
-- 
2.27.0

Re: [PATCH] docs/virt: add a blank line and some - to kvm api

[yanteng si]

Yanteng Si <siyanteng01@gmail.com> 于2021年12月9日周四 17:15写道：
>
> Since 0e691ee7b5034 ("KVM:Documentation: Fix KVM_CAP_ENFORCE_PV_FEATURE_CPUID name") which
> introduced awarning:
>
> /home/siyanteng/mainline/linux/Documentation/virt/kvm/api.rst:6046: WARNING: Literal block ends without a blank line; unexpected unindent.
> /home/siyanteng/mainline/linux/Documentation/virt/kvm/api.rst:7296: WARNING: Title underline too short.
>
> 8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
> -----------------------------
> /home/siyanteng/mainline/linux/Documentation/virt/kvm/api.rst:7296: WARNING: Title underline too short.
>
> 8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
> -----------------------------
>
> Add 8 "-" for (8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID)
> Add a blank line.
>
> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
> ---
>  Documentation/virt/kvm/api.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index aeeb071c7688..a77c4533821f 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -6043,6 +6043,7 @@ Valid values for 'type' are:
>                         unsigned long args[6];
>                         unsigned long ret[2];
>                 } riscv_sbi;
> +
>  If exit reason is KVM_EXIT_RISCV_SBI then it indicates that the VCPU has
>  done a SBI call which is not handled by KVM RISC-V kernel module. The details
>  of the SBI call are available in 'riscv_sbi' member of kvm_run structure. The
> @@ -7293,7 +7294,7 @@ trap and emulate MSRs that are outside of the scope of KVM as well as
>  limit the attack surface on KVM's MSR emulation code.
>
>  8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
> ------------------------------
> +-------------------------------------
>
>  Architectures: x86
>
> --
> 2.27.0
>

Ping


Thanks,
Yanteng