Commit cb0c5a60 authored by Gopi Krishna Menon's avatar Gopi Krishna Menon Committed by Will Deacon
Browse files

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: default avatarGopi Krishna Menon <krishnagopi487@gmail.com>
Reviewed-by: default avatarKoichi Okuno <fj2767dz@fujitsu.com>
Fixes: bad11557 ("perf: Fujitsu: Add the Uncore PMU driver")
Reviewed-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarWill Deacon <will@kernel.org>
parent 200b0d25

Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst

+6 −1
Original line number Diff line number Diff line
@@ -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