linux-kernel - Re: [PATCH] docs: fix 'make htmldocs' warning in perf

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] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 1 Mar 2022 07:52:44 +0000
From:   John Garry <john.garry@...wei.com>
To:     Wan Jiabing <wanjiabing@...o.com>,
        Jonathan Corbet <corbet@....net>,
        Shaokun Zhang <zhangshaokun@...ilicon.com>,
        Qi Liu <liuqi115@...wei.com>, Will Deacon <will@...nel.org>,
        <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>
CC:     <jiabing.wan@...com>
Subject: Re: [PATCH] docs: fix 'make htmldocs' warning in perf

On 28/02/2022 03:16, Wan Jiabing wrote:
> Fix following 'make htmldocs' warnings:
> ./Documentation/admin-guide/perf/hisi-pcie-pmu.rst: WARNING:
> document isn't included in any toctree
> 
> Fixes: c8602008e247 ("docs: perf: Add description for HiSilicon PCIe PMU driver")
> Signed-off-by: Wan Jiabing <wanjiabing@...o.com>

Regardless of nit, below:

Reviewed-by: John Garry <john.garry@...wei.com>

> ---
>   Documentation/admin-guide/perf/index.rst | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/admin-guide/perf/index.rst b/Documentation/admin-guide/perf/index.rst
> index 5a8f2529a033..69b23f087c05 100644
> --- a/Documentation/admin-guide/perf/index.rst
> +++ b/Documentation/admin-guide/perf/index.rst
> @@ -8,6 +8,7 @@ Performance monitor support
>      :maxdepth: 1
>   
>      hisi-pmu
> +   hisi-pcie-pmu

nit: we might prefer alphabetic ordering, but we don't have it fully ATM 
elsewhere

>      imx-ddr
>      qcom_l2_pmu
>      qcom_l3_pmu