Re: [PATCH v8 4/9] docs: misc-devices: (smpro-errmon) Add documentation

Bagas Sanjaya
2022-04-22T06:27:47Z

On 4/22/22 09:46, Quan Nguyen wrote:
> Adds documentation for Ampere(R)'s Altra(R) SMpro errmon driver.
>

Hi Quan,

Building htmldocs, I got this new warning:

/home/bagas/repo/linux-stable/Documentation/misc-devices/smpro-errmon.rst:128: WARNING: Malformed table.
Column span alignment problem in table line 56.

============ ========== ========= =============== ================
Error Group Error Type Sub type Sub component Instance
CPM 0 0 Snoop-Logic CPM #
CPM 0 2 Armv8 Core 1 CPM #
MCU 1 1 ERR1 MCU # | SLOT << 11
MCU 1 2 ERR2 MCU # | SLOT << 11
MCU 1 3 ERR3 MCU #
MCU 1 4 ERR4 MCU #
MCU 1 5 ERR5 MCU #
MCU 1 6 ERR6 MCU #
MCU 1 7 Link Error MCU #
Mesh 2 0 Cross Point X | (Y << 5) | NS <<11
Mesh 2 1 Home Node(IO) X | (Y << 5) | NS <<11
Mesh 2 2 Home Node(Mem) X | (Y << 5) | NS <<11 | device<<12
Mesh 2 4 CCIX Node X | (Y << 5) | NS <<11
2P Link 3 0 N/A Altra 2P Link #
GIC 5 0 ERR0 0
GIC 5 1 ERR1 0
GIC 5 2 ERR2 0
GIC 5 3 ERR3 0
GIC 5 4 ERR4 0
GIC 5 5 ERR5 0
GIC 5 6 ERR6 0
GIC 5 7 ERR7 0
GIC 5 8 ERR8 0
GIC 5 9 ERR9 0
GIC 5 10 ERR10 0
GIC 5 11 ERR11 0
GIC 5 12 ERR12 0
GIC 5 13-21 ERR13 RC# + 1
SMMU 6 TCU 100 RC #
SMMU 6 TBU0 0 RC #
SMMU 6 TBU1 1 RC #
SMMU 6 TBU2 2 RC #
SMMU 6 TBU3 3 RC #
SMMU 6 TBU4 4 RC #
SMMU 6 TBU5 5 RC #
SMMU 6 TBU6 6 RC #
SMMU 6 TBU7 7 RC #
SMMU 6 TBU8 8 RC #
SMMU 6 TBU9 9 RC #
PCIe AER 7 Root 0 RC #
PCIe AER 7 Device 1 RC #
PCIe RC 8 RCA HB 0 RC #
PCIe RC 8 RCB HB 1 RC #
PCIe RC 8 RASDP 8 RC #
OCM 9 ERR0 0 0
OCM 9 ERR1 1 0
OCM 9 ERR2 2 0
SMpro 10 ERR0 0 0
SMpro 10 ERR1 1 0
SMpro 10 MPA_ERR 2 0
PMpro 11 ERR0 0 0
PMpro 11 ERR1 1 0
PMpro 11 MPA_ERR 2 0
============= ========== ========= =============== ================

I have applied the following fixup:

From f16c63afa2064247507762ffcb623f575043f4a6 Mon Sep 17 00:00:00 2001
From: Bagas Sanjaya <bagasdotme@gmail.com>
Date: Fri, 22 Apr 2022 13:16:31 +0700
Subject: [PATCH] fixup for "docs: misc-devices: (smpro-errmon) Add
documentation"

Fix table syntax warning

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/misc-devices/smpro-errmon.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/misc-devices/smpro-errmon.rst b/Documentation/misc-devices/smpro-errmon.rst
index 53599904da7008..818f12bd8aca4d 100644
--- a/Documentation/misc-devices/smpro-errmon.rst
+++ b/Documentation/misc-devices/smpro-errmon.rst
@@ -70,8 +70,9 @@ The format of the error lines is defended on the alert/event type.

Below table defines the value of Error types, Sub Types, Sub component and instance:

- ============ ========== ========= =============== ================
+ ============ ========== ========= =============== ====================================
Error Group Error Type Sub type Sub component Instance
+ ============ ========== ========= =============== ====================================
CPM 0 0 Snoop-Logic CPM #
CPM 0 2 Armv8 Core 1 CPM #
MCU 1 1 ERR1 MCU # | SLOT << 11
@@ -125,7 +126,7 @@ Below table defines the value of Error types, Sub Types, Sub component and insta
PMpro 11 ERR0 0 0
PMpro 11 ERR1 1 0
PMpro 11 MPA_ERR 2 0
- ============= ========== ========= =============== ================
+ ============ ========== ========= =============== ====================================

2) Type 2 for the Internal SMpro/PMpro alert types::
--
An old man doll... just what I always wanted! - Clara

For consistency with the fixup, you need to format the tables so that
headings will be emphasized, by adding second ='s line before first
content row.

Thanks.

--
An old man doll... just what I always wanted! - Clara