linux-kernel - RE: [PATCH v3] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

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]

Message-ID:
 <OSCPR01MB12819E309F236061FAD98416DC11EA@OSCPR01MB12819.jpnprd01.prod.outlook.com>
Date: Fri, 26 Sep 2025 09:07:27 +0000
From: "Koichi Okuno (Fujitsu)" <fj2767dz@...itsu.com>
To: 'Gopi Krishna Menon' <krishnagopi487@...il.com>, "corbet@....net"
	<corbet@....net>, "will@...nel.org" <will@...nel.org>,
	"yangyicong@...ilicon.com" <yangyicong@...ilicon.com>
CC: "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	"skhan@...uxfoundation.org" <skhan@...uxfoundation.org>,
	"david.hunter.linux@...il.com" <david.hunter.linux@...il.com>,
	"linux-kernel-mentees@...ts.linux.dev"
	<linux-kernel-mentees@...ts.linux.dev>, Randy Dunlap <rdunlap@...radead.org>,
	"Koichi Okuno (Fujitsu)" <fj2767dz@...itsu.com>
Subject: RE: [PATCH v3] docs: perf: Fujitsu: Fix htmldocs build warnings and
 errors

Hi Gopi and Will,

Many thanks, Gopi, for submitting this updated patch to improve the documentation.
Reviewed-by: Koichi Okuno <fj2767dz@...itsu.com>

Will, please consider applying this patch.
(To be clear: base patch "perf: Fujitsu: Add the Uncore PMU driver" is currently in for-next/perf)

> Running "make htmldocs" generates the following build errors and
> warnings for fujitsu_uncore_pmu.rst:
> 
> Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:20: ERROR: Unexpected indentation.
> Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:23: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:28: ERROR: Unexpected indentation.
> Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:29: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:81: ERROR: Unexpected indentation.
> Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:82: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Add blank line before bullet lists, block quotes to fix build
> errors, resolve warnings and properly render perf commands as
> code blocks.
> 
> Signed-off-by: Gopi Krishna Menon <krishnagopi487@...il.com>
> ---
> Changelog:
> 
> Changes in v3:
>   - Properly render perf commands as code blocks (use "e.g.::").
> 
> Changes in v2:
>   - Remove formatting changes unrelated to the fix.
> 
> Suggested-by: Randy Dunlap <rdunlap@...radead.org>
> Suggested-by: Shuah Khan <skhan@...uxfoundation.org>
> 
>  Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
> index 46595b788d3a..2ec0249e37b6 100644
> --- a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
> +++ b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
> @@ -15,15 +15,19 @@ The driver provides a description of its available events and configuration
>  options in sysfs, see /sys/bus/event_sources/devices/mac_iod<iod>_mac<mac>_ch<ch>/
>  and /sys/bus/event_sources/devices/pci_iod<iod>_pci<pci>/.
>  This driver exports:
> +
>  - formats, used by perf user space and other tools to configure events
>  - events, used by perf user space and other tools to create events
> -  symbolically, e.g.:
> +  symbolically, e.g.::
> +
>      perf stat -a -e mac_iod0_mac0_ch0/event=0x21/ ls
>      perf stat -a -e pci_iod0_pci0/event=0x24/ ls
> +
>  - cpumask, used by perf user space and other tools to know on which CPUs
>    to open the events
> 
>  This driver supports the following events for MAC:
> +
>  - cycles
>    This event counts MAC cycles at MAC frequency.
>  - read-count
> @@ -77,6 +81,7 @@ Examples for use with perf::
>    perf stat -e mac_iod0_mac0_ch0/ea-mac/ ls
> 
>  And, this driver supports the following events for PCI:
> +
>  - pci-port0-cycles
>    This event counts PCI cycles at PCI frequency in port0.
>  - pci-port0-read-count

Best Regards,
Koichi Okuno