linux-next.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH -next] drivers/perf: hisi: Fix build warning of hisi-pcie-pmu.rst
@ 2024-03-05 12:10 Yicong Yang
  2024-03-05 12:24 ` Yicong Yang
  0 siblings, 1 reply; 2+ messages in thread
From: Yicong Yang @ 2024-03-05 12:10 UTC (permalink / raw)
  To: will, sfr, linux-kernel, linux-next; +Cc: hejunhao3, yangyicong

From: Yicong Yang <yangyicong@hisilicon.com>

`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/20231011172250.5a6498e5@canb.auug.org.au/
Fixes: 89a032923d4b ("docs: perf: Update usage for target filter of hisi-pcie-pmu")
Signed-off-by: Yicong Yang <yangyicong@hisilicon.com>
---
 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


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH -next] drivers/perf: hisi: Fix build warning of hisi-pcie-pmu.rst
  2024-03-05 12:10 [PATCH -next] drivers/perf: hisi: Fix build warning of hisi-pcie-pmu.rst Yicong Yang
@ 2024-03-05 12:24 ` Yicong Yang
  0 siblings, 0 replies; 2+ messages in thread
From: Yicong Yang @ 2024-03-05 12:24 UTC (permalink / raw)
  To: will, sfr, linux-kernel, linux-next; +Cc: hejunhao3, yangyicong

The subject should be:

docs: perf: hisi: Fix build warning of hisi-pcie-pmu.rst

Will get this fixed. Sorry for the mistake.

On 2024/3/5 20:10, Yicong Yang wrote:
> From: Yicong Yang <yangyicong@hisilicon.com>
> 
> `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/20231011172250.5a6498e5@canb.auug.org.au/
> Fixes: 89a032923d4b ("docs: perf: Update usage for target filter of hisi-pcie-pmu")
> Signed-off-by: Yicong Yang <yangyicong@hisilicon.com>
> ---
>  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".
> 

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2024-03-05 12:24 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-03-05 12:10 [PATCH -next] drivers/perf: hisi: Fix build warning of hisi-pcie-pmu.rst Yicong Yang
2024-03-05 12:24 ` Yicong Yang

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).