linux-kernel - [PATCH v1] Documentation/admin-guide/perf: Fix indentation and formatting in fujitsu_uncore

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-next>] [day] [month] [year] [list]

Message-ID: <20250930100742.4741-1-swarajgaikwad1925@gmail.com>
Date: Tue, 30 Sep 2025 10:07:36 +0000
From: Swaraj Gaikwad <swarajgaikwad1925@...il.com>
To: Jonathan Corbet <corbet@....net>,
	Koichi Okuno <fj2767dz@...itsu.com>,
	Yicong Yang <yangyicong@...ilicon.com>,
	Will Deacon <will@...nel.org>,
	linux-doc@...r.kernel.org (open list:DOCUMENTATION),
	linux-kernel@...r.kernel.org (open list)
Cc: skhan@...uxfoundation.org,
	david.hunter.linux@...il.com,
	Swaraj Gaikwad <swarajgaikwad1925@...il.com>
Subject: [PATCH v1] Documentation/admin-guide/perf: Fix indentation and formatting in fujitsu_uncore_pmu.rst

This patch fixes several reStructuredText (RST) formatting issues in
documentation/admin-guide/perf/fujitsu_uncore_pmu.rst that were causing
Sphinx build warnings and errors. Specifically:

- Unexpected indentation in bullet lists.
- Block-quote unindents that broke literal blocks.
- Missing blank lines between paragraphs and lists.

Reason for the patch:
Without these fixes, running `make docs` for the perf documentation
would produce warnings like "Unexpected indentation" and "Block quote
unindented", and could lead to incorrectly rendered documentation.
This patch ensures proper formatting and readability of the fujitsu_uncore_pmu
documentation, which is important for developers and users referencing
PMU events.

Changes made:
- Added blank lines between introductory text and bullet lists.
- Used double colon `::` for literal blocks.
- Adjusted indentation of list items and surrounding text.

Testing:
- Verified `make htmldocs` runs without emitting indentation or block-quote warnings after applying the patch.

Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@...il.com>
---
 Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
index 46595b788d3a..31e6e535d11b 100644
--- a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
+++ b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
@@ -14,16 +14,21 @@ pci_iod<iod>_pci<pci>.
 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
@@ -69,7 +74,6 @@ This driver supports the following events for MAC:
   This event counts the number of write requests from MAC to memory.
 - ea-ha
   This event counts energy consumption of HA.
-
   'ea' is the abbreviation for 'Energy Analyzer'.

 Examples for use with perf::
@@ -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
@@ -99,7 +104,6 @@ And, this driver supports the following events for PCI:
   This event counts write transactions for bus usage in port1.
 - ea-pci
   This event counts energy consumption of PCI.
-
   'ea' is the abbreviation for 'Energy Analyzer'.

 Examples for use with perf::
--
2.51.0