From: Gopi Krishna Menon <krishnagopi487@gmail.com>
To: corbet@lwn.net, will@kernel.org, yangyicong@hisilicon.com,
fj2767dz@fujitsu.com
Cc: Gopi Krishna Menon <krishnagopi487@gmail.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
skhan@linuxfoundation.org, david.hunter.linux@gmail.com,
linux-kernel-mentees@lists.linux.dev
Subject: [PATCH v2] docs: perf: Fujitsu: Fix htmldocs build warnings and errors
Date: Fri, 26 Sep 2025 06:09:36 +0530 [thread overview]
Message-ID: <20250926003938.5017-1-krishnagopi487@gmail.com> (raw)
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
next reply other threads:[~2025-09-26 0:39 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-26 0:39 Gopi Krishna Menon [this message]
2025-09-26 3:27 ` [PATCH v2] docs: perf: Fujitsu: Fix htmldocs build warnings and errors Randy Dunlap
2025-09-26 4:36 ` [PATCH v3] " Gopi Krishna Menon
2025-09-26 5:14 ` Randy Dunlap
2025-09-26 6:33 ` Bagas Sanjaya
2025-09-26 9:07 ` Koichi Okuno (Fujitsu)
2025-09-26 13:39 ` Will Deacon
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=20250926003938.5017-1-krishnagopi487@gmail.com \
--to=krishnagopi487@gmail.com \
--cc=corbet@lwn.net \
--cc=david.hunter.linux@gmail.com \
--cc=fj2767dz@fujitsu.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.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