[PATCH v2] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

[PATCH v2] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

[Gopi Krishna Menon]

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 and block quotes to fix build
errors and resolve warnings.

Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
---
Changelog:

Changes since v1:
  - Remove formatting changes unrelated to the fix.
  
Suggested-by: Shuah Khan <skhan@linuxfoundation.org>

 Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
index 46595b788d3a..4edf26f8cfe6 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.:
+
     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
-- 
2.43.0

Re: [PATCH v2] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

[Randy Dunlap]

Hi,

On 9/25/25 5:39 PM, Gopi Krishna Menon wrote:
> 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 and block quotes to fix build
> errors and resolve warnings.
> 

Yes, this is better. No warnings, but some of the output
html file still isn't formatted as expected or desired.
See comments below.

> Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
> ---
> Changelog:
> 
> Changes since v1:
>    - Remove formatting changes unrelated to the fix.
>    
> Suggested-by: Shuah Khan <skhan@linuxfoundation.org>
> 
>   Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
> index 46595b788d3a..4edf26f8cfe6 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.:
> +
>       perf stat -a -e mac_iod0_mac0_ch0/event=0x21/ ls
>       perf stat -a -e pci_iod0_pci0/event=0x24/ ls

This produces:

events, used by perf user space and other tools to create events 
symbolically, e.g.:

perf stat -a -e mac_iod0_mac0_ch0/event=0x21/ ls perf stat -a -e 
pci_iod0_pci0/event=0x24/ ls

(That last line is all on one line in my browser.)

Please try using "e.g.::" before those 2 perf lines.
And then check the output in a browser.

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

Thanks.
-- 
~Randy

[PATCH v3] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

[Gopi Krishna Menon]

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@gmail.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@infradead.org>
Suggested-by: Shuah Khan <skhan@linuxfoundation.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
-- 
2.43.0

Re: [PATCH v3] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

[Randy Dunlap]

On 9/25/25 9:36 PM, Gopi Krishna Menon wrote:
> 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@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 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@infradead.org>
> Suggested-by: Shuah Khan <skhan@linuxfoundation.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

-- 
~Randy

Re: [PATCH v3] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1690 bytes --]

On Fri, Sep 26, 2025 at 10:06:12AM +0530, Gopi Krishna Menon wrote:
> 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

LGTM, thanks!

Fixes: bad11557eed2 ("perf: Fujitsu: Add the Uncore PMU driver")
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

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

[Koichi Okuno (Fujitsu)]

Hi Gopi and Will,

Many thanks, Gopi, for submitting this updated patch to improve the documentation.
Reviewed-by: Koichi Okuno <fj2767dz@fujitsu.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@gmail.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@infradead.org>
> Suggested-by: Shuah Khan <skhan@linuxfoundation.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

Re: [PATCH v3] docs: perf: Fujitsu: Fix htmldocs build warnings and errors

[Will Deacon]

On Fri, 26 Sep 2025 10:06:12 +0530, Gopi Krishna Menon wrote:
> 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.
> 
> [...]

Applied to arm64 (for-next/core), thanks!

[1/1] docs: perf: Fujitsu: Fix htmldocs build warnings and errors
      https://git.kernel.org/arm64/c/cb0c5a60a6f7

Cheers,
-- 
Will

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