2024-03-05 12:52:45

by Yicong Yang

Subject: [PATCH -next v2] docs: perf: Fix build warning of hisi-pcie-pmu.rst

From: Yicong Yang <[email protected]>

`make htmldocs SPHINXDIRS="admin-guide"` shows below warnings:
Documentation/admin-guide/perf/hisi-pcie-pmu.rst:48: ERROR: Unexpected indentation.
Documentation/admin-guide/perf/hisi-pcie-pmu.rst:49: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix this.

Closes: https://lore.kernel.org/lkml/[email protected]/
Fixes: 89a032923d4b ("docs: perf: Update usage for target filter of hisi-pcie-pmu")
Signed-off-by: Yicong Yang <[email protected]>
---
Change since v1:
- Fix the subject prefix
Link: https://lore.kernel.org/all/[email protected]/

Documentation/admin-guide/perf/hisi-pcie-pmu.rst | 1 +
1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/perf/hisi-pcie-pmu.rst b/Documentation/admin-guide/perf/hisi-pcie-pmu.rst
index 678d3865560c..5541ff40e06a 100644
--- a/Documentation/admin-guide/perf/hisi-pcie-pmu.rst
+++ b/Documentation/admin-guide/perf/hisi-pcie-pmu.rst
@@ -44,6 +44,7 @@ The related events usually used to calculate the bandwidth, latency or others.
They need to start and end counting at the same time, therefore related events
are best used in the same event group to get the expected value. There are two
ways to know if they are related events:
+
a) By event name, such as the latency events "xxx_latency, xxx_cnt" or
bandwidth events "xxx_flux, xxx_time".
b) By event type, such as "event=0xXXXX, event=0x1XXXX".
--
2.24.0

2024-03-05 17:12:51

by Will Deacon

Subject: Re: [PATCH -next v2] docs: perf: Fix build warning of hisi-pcie-pmu.rst

On Tue, 05 Mar 2024 20:25:17 +0800, Yicong Yang wrote:
> `make htmldocs SPHINXDIRS="admin-guide"` shows below warnings:
> Documentation/admin-guide/perf/hisi-pcie-pmu.rst:48: ERROR: Unexpected indentation.
> Documentation/admin-guide/perf/hisi-pcie-pmu.rst:49: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Fix this.
>
>
> [...]

Thank you, this is much better than the kludge I had put together myself.

Applied to will (for-next/perf), thanks!

[1/1] docs: perf: Fix build warning of hisi-pcie-pmu.rst
https://git.kernel.org/will/c/b037e40a6af2

Cheers,
--
Will

https://fixes.arm64.dev
https://next.arm64.dev
https://will.arm64.dev