From: Shuah Khan <skhan@linuxfoundation.org>
To: Gopi Krishna Menon <krishnagopi487@gmail.com>,
corbet@lwn.net, fj2767dz@fujitsu.com, will@kernel.org,
yangyicong@hisilicon.com
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
david.hunter.linux@gmail.com,
linux-kernel-mentees@lists.linux.dev,
Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH] docs: perf: cleanup fujitsu_uncore_pmu.rst and fix htmldocs warnings/errors
Date: Thu, 25 Sep 2025 14:06:14 -0600 [thread overview]
Message-ID: <650a4711-1d33-4582-be84-19ab99ff7f82@linuxfoundation.org> (raw)
In-Reply-To: <20250925195442.71997-1-krishnagopi487@gmail.com>
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@gmail.com>
> ---
> .../admin-guide/perf/fujitsu_uncore_pmu.rst | 130 ++++++++++++------
> 1 file changed, 87 insertions(+), 43 deletions(-)
>
thanks,
-- Shuah
prev parent reply other threads:[~2025-09-25 20:06 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-25 19:54 [PATCH] docs: perf: cleanup fujitsu_uncore_pmu.rst and fix htmldocs warnings/errors Gopi Krishna Menon
2025-09-25 20:06 ` Shuah Khan [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=650a4711-1d33-4582-be84-19ab99ff7f82@linuxfoundation.org \
--to=skhan@linuxfoundation.org \
--cc=corbet@lwn.net \
--cc=david.hunter.linux@gmail.com \
--cc=fj2767dz@fujitsu.com \
--cc=krishnagopi487@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=will@kernel.org \
--cc=yangyicong@hisilicon.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox