From: Paolo Bonzini <pbonzini@redhat.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Alexandru Elisei <alexandru.elisei@arm.com>,
Andrew Jones <drjones@redhat.com>, Marc Zyngier <maz@kernel.org>,
Mathieu Poirier <mathieu.poirier@linaro.org>,
kvm@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 2/6] docs: vcpu.rst: fix some build warnings
Date: Fri, 2 Oct 2020 09:58:09 +0200 [thread overview]
Message-ID: <c3cb6146-4910-ea8e-f07c-9935cb971a18@redhat.com> (raw)
In-Reply-To: <b5385dd0213f1f070667925bf7a807bf5270ba78.1601616399.git.mchehab+huawei@kernel.org>
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 <mchehab+huawei@kernel.org>
> ---
> 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
>
> - __u8 action;
> - __u8 pad[3];
> -};
> + __u8 action;
> + __u8 pad[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 <pbonzini@redhat.com>
next prev parent reply other threads:[~2020-10-02 7:58 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-02 5:49 [PATCH 0/6] Fix new html build warnings from next-20201001 Mauro Carvalho Chehab
2020-10-02 5:49 ` [PATCH 1/6] net: core: document two new elements of struct net_device Mauro Carvalho Chehab
2020-10-02 22:16 ` David Miller
2020-10-02 5:49 ` [PATCH 2/6] docs: vcpu.rst: fix some build warnings Mauro Carvalho Chehab
2020-10-02 7:58 ` Paolo Bonzini [this message]
2020-10-02 5:49 ` [PATCH 3/6] docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markup Mauro Carvalho Chehab
2020-10-02 7:38 ` Anton Ivanov
2020-10-02 5:49 ` [PATCH 4/6] docs: i2c: index.rst: add slave-testunit-backend.rst Mauro Carvalho Chehab
2020-10-02 7:54 ` Wolfram Sang
2020-10-02 9:02 ` Mauro Carvalho Chehab
2020-10-02 5:49 ` [PATCH 5/6] scripts: kernel-doc: add support for typedef enum Mauro Carvalho Chehab
2020-10-02 12:07 ` Andrew Lunn
2020-10-03 7:24 ` Mauro Carvalho Chehab
2020-10-02 5:49 ` [PATCH 6/6] docs: gpio: add a new document to its index.rst Mauro Carvalho Chehab
2020-10-02 15:28 ` Bartosz Golaszewski
2020-10-03 0:02 ` Kent Gibson
2020-10-07 8:41 ` Linus Walleij
2020-10-02 8:19 ` [PATCH 0/6] Fix new html build warnings from next-20201001 Marc Zyngier
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=c3cb6146-4910-ea8e-f07c-9935cb971a18@redhat.com \
--to=pbonzini@redhat.com \
--cc=alexandru.elisei@arm.com \
--cc=corbet@lwn.net \
--cc=drjones@redhat.com \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mathieu.poirier@linaro.org \
--cc=maz@kernel.org \
--cc=mchehab+huawei@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).