linux-kernel - Re: [PATCH] docs: perf: cleanup fujitsu_uncore_pmu.rst and fix htmldocs warnings/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] [day] [month] [year] [list]

Message-ID: <650a4711-1d33-4582-be84-19ab99ff7f82@linuxfoundation.org>
Date: Thu, 25 Sep 2025 14:06:14 -0600
From: Shuah Khan <skhan@...uxfoundation.org>
To: Gopi Krishna Menon <krishnagopi487@...il.com>, corbet@....net,
 fj2767dz@...itsu.com, will@...nel.org, yangyicong@...ilicon.com
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 david.hunter.linux@...il.com, linux-kernel-mentees@...ts.linux.dev,
 Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH] docs: perf: cleanup fujitsu_uncore_pmu.rst and fix
 htmldocs warnings/errors

On 9/25/25 13:54, Gopi Krishna Menon wrote:
> - Adjust spacing around list and sections for better readability.
> - Use definition lists for defining events.
> - Replace block quotes with code blocks where appropriate.

The bullet list type format used above isn't right format for
change log. Refer to a few change logs and also check submitting
patches documentation.

Sounds like you are combining formatting changes and warning
fixes. These are better done as separate patches.
> 
> Fixes the following htmldocs errors/warnings:
> 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.
> 
> Signed-off-by: Gopi Krishna Menon <krishnagopi487@...il.com>
> ---
>   .../admin-guide/perf/fujitsu_uncore_pmu.rst   | 130 ++++++++++++------
>   1 file changed, 87 insertions(+), 43 deletions(-)
> 

thanks,
-- Shuah