Re: [PATCH 2/6] docs: vcpu.rst: fix some build warnings

[Paolo Bonzini]

On 02/10/20 07:49, Mauro Carvalho Chehab wrote:
> As warned with make htmldocs:
> 
>   .../Documentation/virt/kvm/devices/vcpu.rst:70: WARNING: Malformed 
> table.
>   Text in column margin in table line 2.
> 
>   ===  ==
>   -ENODEV: PMUv3 not supported or GIC not initialized
>   -ENXIO:  PMUv3 not properly configured or in-kernel irqchip not
>configured as required prior to calling this attribute
>   -EBUSY:  PMUv3 already initialized
>   -EINVAL: Invalid filter range
>   ===  ==
> 
> The ':' character for two lines are above the size of the column.
> Besides that, other tables at the file doesn't use ':', so
> just drop them.
> 
> While here, also fix this warning also introduced at the same patch:
> 
>   .../Documentation/virt/kvm/devices/vcpu.rst:88: WARNING: Block quote 
> ends without a blank line; unexpected unindent.
> 
> By marking the C code as a literal block.
> 
> Fixes: 8be86a5eec04 ("KVM: arm64: Document PMU filtering API")
> Signed-off-by: Mauro Carvalho Chehab 
> ---
>  Documentation/virt/kvm/devices/vcpu.rst | 26 -
>  1 file changed, 13 insertions(+), 13 deletions(-)
> 
> diff --git a/Documentation/virt/kvm/devices/vcpu.rst 
> b/Documentation/virt/kvm/devices/vcpu.rst
> index da7c2ef7dafc..2acec3b9ef65 100644
> --- a/Documentation/virt/kvm/devices/vcpu.rst
> +++ b/Documentation/virt/kvm/devices/vcpu.rst
> @@ -67,25 +67,25 @@ irqchip.
>  :Returns:
>  
>===  ==
> -  -ENODEV: PMUv3 not supported or GIC not initialized
> -  -ENXIO:  PMUv3 not properly configured or in-kernel irqchip not
> +  -ENODEV  PMUv3 not supported or GIC not initialized
> +  -ENXIO   PMUv3 not properly configured or in-kernel irqchip not
> configured as required prior to calling this attribute
> -  -EBUSY:  PMUv3 already initialized
> -  -EINVAL: Invalid filter range
> +  -EBUSY   PMUv3 already initialized
> +  -EINVAL  Invalid filter range
>===  ==
>  
> -Request the installation of a PMU event filter described as follows:
> +Request the installation of a PMU event filter described as follows::
>  
> -struct kvm_pmu_event_filter {
> - __u16   base_event;
> - __u16   nevents;
> +struct kvm_pmu_event_filter {
> + __u16   base_event;
> + __u16   nevents;
>  
> -#define KVM_PMU_EVENT_ALLOW  0
> -#define KVM_PMU_EVENT_DENY   1
> +#define KVM_PMU_EVENT_ALLOW  0
> +#define KVM_PMU_EVENT_DENY   1
>  
> - __u8action;
> - __u8pad[3];
> -};
> + __u8action;
> + __u8pad[3];
> +};
>  
>  A filter range is defined as the range [@base_event, @base_event + @nevents),
>  together with an @action (KVM_PMU_EVENT_ALLOW or KVM_PMU_EVENT_DENY). The
> 

Acked-by: Paolo Bonzini 

[PATCH 2/6] docs: vcpu.rst: fix some build warnings

[Mauro Carvalho Chehab]

As warned with make htmldocs:

.../Documentation/virt/kvm/devices/vcpu.rst:70: WARNING: Malformed 
table.
Text in column margin in table line 2.

===  ==
-ENODEV: PMUv3 not supported or GIC not initialized
-ENXIO:  PMUv3 not properly configured or in-kernel irqchip not
 configured as required prior to calling this attribute
-EBUSY:  PMUv3 already initialized
-EINVAL: Invalid filter range
===  ==

The ':' character for two lines are above the size of the column.
Besides that, other tables at the file doesn't use ':', so
just drop them.

While here, also fix this warning also introduced at the same patch:

.../Documentation/virt/kvm/devices/vcpu.rst:88: WARNING: Block quote 
ends without a blank line; unexpected unindent.

By marking the C code as a literal block.

Fixes: 8be86a5eec04 ("KVM: arm64: Document PMU filtering API")
Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/virt/kvm/devices/vcpu.rst | 26 -
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/Documentation/virt/kvm/devices/vcpu.rst 
b/Documentation/virt/kvm/devices/vcpu.rst
index da7c2ef7dafc..2acec3b9ef65 100644
--- a/Documentation/virt/kvm/devices/vcpu.rst
+++ b/Documentation/virt/kvm/devices/vcpu.rst
@@ -67,25 +67,25 @@ irqchip.
 :Returns:
 
 ===  ==
--ENODEV: PMUv3 not supported or GIC not initialized
--ENXIO:  PMUv3 not properly configured or in-kernel irqchip not
+-ENODEV  PMUv3 not supported or GIC not initialized
+-ENXIO   PMUv3 not properly configured or in-kernel irqchip not
  configured as required prior to calling this attribute
--EBUSY:  PMUv3 already initialized
--EINVAL: Invalid filter range
+-EBUSY   PMUv3 already initialized
+-EINVAL  Invalid filter range
 ===  ==
 
-Request the installation of a PMU event filter described as follows:
+Request the installation of a PMU event filter described as follows::
 
-struct kvm_pmu_event_filter {
-   __u16   base_event;
-   __u16   nevents;
+struct kvm_pmu_event_filter {
+   __u16   base_event;
+   __u16   nevents;
 
-#define KVM_PMU_EVENT_ALLOW0
-#define KVM_PMU_EVENT_DENY 1
+#define KVM_PMU_EVENT_ALLOW0
+#define KVM_PMU_EVENT_DENY 1
 
-   __u8action;
-   __u8pad[3];
-};
+   __u8action;
+   __u8pad[3];
+};
 
 A filter range is defined as the range [@base_event, @base_event + @nevents),
 together with an @action (KVM_PMU_EVENT_ALLOW or KVM_PMU_EVENT_DENY). The
-- 
2.26.2