linux-kernel - Re: [PATCH v3] Loongarch: KVM: Add KVM hypercalls documentation for LoongArch

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <877cbphmhm.fsf@trenco.lwn.net>
Date: Thu, 05 Sep 2024 14:30:29 -0600
From: Jonathan Corbet <corbet@....net>
To: Dandan Zhang <zhangdandan@...ontech.com>, pbonzini@...hat.com,
 zhaotianrui@...ngson.cn, maobibo@...ngson.cn, chenhuacai@...nel.org,
 zenghui.yu@...ux.dev
Cc: kernel@...0n.name, kvm@...r.kernel.org, loongarch@...ts.linux.dev,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 guanwentao@...ontech.com, wangyuli@...ontech.com,
 baimingcong@...ontech.com, Xianglai Li <lixianglai@...ngson.cn>, Mingcong
 Bai <jeffbai@...c.io>, Dandan Zhang <zhangdandan@...ontech.com>
Subject: Re: [PATCH v3] Loongarch: KVM: Add KVM hypercalls documentation for
 LoongArch

Dandan Zhang <zhangdandan@...ontech.com> writes:

> From: Bibo Mao <maobibo@...ngson.cn>
>
> Add documentation topic for using pv_virt when running as a guest
> on KVM hypervisor.
>
> Signed-off-by: Bibo Mao <maobibo@...ngson.cn>
> Signed-off-by: Xianglai Li <lixianglai@...ngson.cn>
> Co-developed-by: Mingcong Bai <jeffbai@...c.io>
> Signed-off-by: Mingcong Bai <jeffbai@...c.io>
> Link: https://lore.kernel.org/all/5c338084b1bcccc1d57dce9ddb1e7081@aosc.io/
> Signed-off-by: Dandan Zhang <zhangdandan@...ontech.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