2022-02-28 06:31:46

by Jiabing Wan

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

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 <[email protected]>
---
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

2022-03-01 08:53:28

by John Garry

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 <[email protected]>

Regardless of nit, below:

Reviewed-by: John Garry <[email protected]>

> ---
> 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

2022-03-04 17:36:33

by Jonathan Corbet

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

Wan Jiabing <[email protected]> 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 <[email protected]>
> ---
> 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