summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGopi Krishna Menon <krishnagopi487@gmail.com>2025-09-26 10:06:12 +0530
committerWill Deacon <will@kernel.org>2025-09-26 14:34:35 +0100
commitcb0c5a60a6f7dd7f35fa5b46fd04dfb66b37fc1e (patch)
tree38105916d808e3ac3d971d1910d0bcf4df78d2a1
parent200b0d25084d6e99f9f08229283b14b60a84c657 (diff)
docs: perf: Fujitsu: Fix htmldocs build warnings and errors
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: Koichi Okuno <fj2767dz@fujitsu.com> Fixes: bad11557eed2 ("perf: Fujitsu: Add the Uncore PMU driver") Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Will Deacon <will@kernel.org>
-rw-r--r--Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst7
1 files changed, 6 insertions, 1 deletions
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