[PATCH] docs: fix 'make htmldocs' warning in perf

Wan Jiabing posted 1 patch 4 years, 3 months ago
Documentation/admin-guide/perf/index.rst | 1 +
1 file changed, 1 insertion(+)
[PATCH] docs: fix 'make htmldocs' warning in perf
Posted by Wan Jiabing 4 years, 3 months ago
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@vivo.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
    imx-ddr
    qcom_l2_pmu
    qcom_l3_pmu
-- 
2.35.1
Re: [PATCH] docs: fix 'make htmldocs' warning in perf
Posted by John Garry 4 years, 3 months ago
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@vivo.com>

Regardless of nit, below:

Reviewed-by: John Garry <john.garry@huawei.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
Re: [PATCH] docs: fix 'make htmldocs' warning in perf
Posted by Jonathan Corbet 4 years, 3 months ago
Wan Jiabing <wanjiabing@vivo.com> writes:

> 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@vivo.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
>     imx-ddr

Applied, thanks.

jon