linux-kernel - Re: [PATCH v2] 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: <61aace07-890a-4b55-8e84-935ebc4a3be1@infradead.org>
Date: Thu, 25 Sep 2025 20:27:32 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Gopi Krishna Menon <krishnagopi487@...il.com>, corbet@....net,
 will@...nel.org, yangyicong@...ilicon.com, fj2767dz@...itsu.com
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 skhan@...uxfoundation.org, david.hunter.linux@...il.com,
 linux-kernel-mentees@...ts.linux.dev
Subject: Re: [PATCH v2] docs: perf: Fujitsu: Fix htmldocs build warnings and
 errors

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@...il.com>
> ---
> Changelog:
> 
> Changes since v1:
>    - Remove formatting changes unrelated to the fix.
>    
> Suggested-by: Shuah Khan <skhan@...uxfoundation.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