linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Dandan Zhang <zhangdandan@uniontech.com>,
	pbonzini@redhat.com, zhaotianrui@loongson.cn,
	maobibo@loongson.cn, chenhuacai@kernel.org, zenghui.yu@linux.dev
Cc: kernel@xen0n.name, kvm@vger.kernel.org,
	loongarch@lists.linux.dev, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, guanwentao@uniontech.com,
	wangyuli@uniontech.com, baimingcong@uniontech.com,
	Xianglai Li <lixianglai@loongson.cn>,
	Mingcong Bai <jeffbai@aosc.io>,
	Dandan Zhang <zhangdandan@uniontech.com>
Subject: Re: [PATCH v3] Loongarch: KVM: Add KVM hypercalls documentation for LoongArch
Date: Thu, 05 Sep 2024 14:30:29 -0600	[thread overview]
Message-ID: <877cbphmhm.fsf@trenco.lwn.net> (raw)
In-Reply-To: <4769C036576F8816+20240828045950.3484113-1-zhangdandan@uniontech.com>

Dandan Zhang <zhangdandan@uniontech.com> writes:

> From: Bibo Mao <maobibo@loongson.cn>
>
> Add documentation topic for using pv_virt when running as a guest
> on KVM hypervisor.
>
> Signed-off-by: Bibo Mao <maobibo@loongson.cn>
> Signed-off-by: Xianglai Li <lixianglai@loongson.cn>
> Co-developed-by: Mingcong Bai <jeffbai@aosc.io>
> Signed-off-by: Mingcong Bai <jeffbai@aosc.io>
> Link: https://lore.kernel.org/all/5c338084b1bcccc1d57dce9ddb1e7081@aosc.io/
> Signed-off-by: Dandan Zhang <zhangdandan@uniontech.com>
> ---
>  Documentation/virt/kvm/index.rst              |  1 +
>  .../virt/kvm/loongarch/hypercalls.rst         | 89 +++++++++++++++++++
>  Documentation/virt/kvm/loongarch/index.rst    | 10 +++
>  MAINTAINERS                                   |  1 +
>  4 files changed, 101 insertions(+)
>  create mode 100644 Documentation/virt/kvm/loongarch/hypercalls.rst
>  create mode 100644 Documentation/virt/kvm/loongarch/index.rst

So this generates a nifty build error:

> Documentation/virt/kvm/loongarch/hypercalls.rst:46: ERROR: Malformed table.
> Text in column margin in table line 5.
> 
> ========        ================        ================
> Register        IN                      OUT
> ========        ================        ================
> a0              function number         Return  code
> a1              1st     parameter       -
> a2              2nd     parameter       -
> a3              3rd     parameter       -
> a4              4th     parameter       -
> a5              5th     parameter       -
> ========        ================        ================

The "====" bar for the middle column is too short.  *Please* be sure
that the documentation actually builds after you make a change.

I have fixed this and applied the patch.

jon

      parent reply	other threads:[~2024-09-05 20:30 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-28  4:59 [PATCH v3] Loongarch: KVM: Add KVM hypercalls documentation for LoongArch Dandan Zhang
2024-08-29  3:22 ` YanTeng Si
2024-08-29  3:33   ` WangYuli
2024-08-30  5:48     ` YanTeng Si
2024-08-30  8:07       ` WangYuli
2024-09-05  3:58 ` maobibo
2024-09-05 20:30 ` Jonathan Corbet [this message]

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=877cbphmhm.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=baimingcong@uniontech.com \
    --cc=chenhuacai@kernel.org \
    --cc=guanwentao@uniontech.com \
    --cc=jeffbai@aosc.io \
    --cc=kernel@xen0n.name \
    --cc=kvm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lixianglai@loongson.cn \
    --cc=loongarch@lists.linux.dev \
    --cc=maobibo@loongson.cn \
    --cc=pbonzini@redhat.com \
    --cc=wangyuli@uniontech.com \
    --cc=zenghui.yu@linux.dev \
    --cc=zhangdandan@uniontech.com \
    --cc=zhaotianrui@loongson.cn \
    /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).