All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Quan Nguyen <quan@os.amperecomputing.com>,
	Lee Jones <lee.jones@linaro.org>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Jean Delvare <jdelvare@suse.com>,
	Guenter Roeck <linux@roeck-us.net>,
	Jonathan Corbet <corbet@lwn.net>,
	Derek Kiernan <derek.kiernan@xilinx.com>,
	Dragan Cvetic <dragan.cvetic@xilinx.com>,
	Arnd Bergmann <arnd@arndb.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Thu Nguyen <thu@os.amperecomputing.com>,
	linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
	OpenBMC Maillist <openbmc@lists.ozlabs.org>
Cc: Open Source Submission <patches@amperecomputing.com>,
	Phong Vo <phong@os.amperecomputing.com>,
	"Thang Q . Nguyen" <thang@os.amperecomputing.com>
Subject: Re: [PATCH v8 4/9] docs: misc-devices: (smpro-errmon) Add documentation
Date: Fri, 22 Apr 2022 13:27:25 +0700	[thread overview]
Message-ID: <07155685-3adf-09c8-9a13-6c8249d5fd74@gmail.com> (raw)
In-Reply-To: <20220422024653.2199489-5-quan@os.amperecomputing.com>

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

WARNING: multiple messages have this Message-ID (diff)
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Quan Nguyen <quan@os.amperecomputing.com>,
	Lee Jones <lee.jones@linaro.org>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Jean Delvare <jdelvare@suse.com>,
	Guenter Roeck <linux@roeck-us.net>,
	Jonathan Corbet <corbet@lwn.net>,
	Derek Kiernan <derek.kiernan@xilinx.com>,
	Dragan Cvetic <dragan.cvetic@xilinx.com>,
	Arnd Bergmann <arnd@arndb.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Thu Nguyen <thu@os.amperecomputing.com>,
	linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
	OpenBMC Maillist <openbmc@lists.ozlabs.org>
Cc: Open Source Submission <patches@amperecomputing.com>,
	"Thang Q . Nguyen" <thang@os.amperecomputing.com>,
	Phong Vo <phong@os.amperecomputing.com>
Subject: Re: [PATCH v8 4/9] docs: misc-devices: (smpro-errmon) Add documentation
Date: Fri, 22 Apr 2022 13:27:25 +0700	[thread overview]
Message-ID: <07155685-3adf-09c8-9a13-6c8249d5fd74@gmail.com> (raw)
In-Reply-To: <20220422024653.2199489-5-quan@os.amperecomputing.com>

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

  reply	other threads:[~2022-04-22  6:27 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-22  2:46 [PATCH v8 0/9] Add Ampere's Altra SMPro MFD and its child drivers Quan Nguyen
2022-04-22  2:46 ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 1/9] hwmon: smpro: Add Ampere's Altra smpro-hwmon driver Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 2/9] docs: hwmon: (smpro-hwmon) Add documentation Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 3/9] misc: smpro-errmon: Add Ampere's SMpro error monitor driver Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22  6:20   ` Greg Kroah-Hartman
2022-04-22  6:20     ` Greg Kroah-Hartman
2022-04-22 14:43     ` Quan Nguyen
2022-04-22 14:43       ` Quan Nguyen
2022-04-22 14:57       ` Greg Kroah-Hartman
2022-04-22 14:57         ` Greg Kroah-Hartman
2022-04-22 17:07         ` Darren Hart
2022-04-22 17:07           ` Darren Hart
2022-04-22 23:21         ` Quan Nguyen
2022-04-22 23:21           ` Quan Nguyen
2022-06-01  8:21     ` Quan Nguyen
2022-06-01  8:21       ` Quan Nguyen
2022-06-01  9:33       ` Greg Kroah-Hartman
2022-06-01  9:33         ` Greg Kroah-Hartman
2022-06-02  9:36         ` Quan Nguyen
2022-06-02  9:36           ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 4/9] docs: misc-devices: (smpro-errmon) Add documentation Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22  6:27   ` Bagas Sanjaya [this message]
2022-04-22  6:27     ` Bagas Sanjaya
2022-04-22  2:46 ` [PATCH v8 5/9] misc: smpro-misc: Add Ampere's Altra SMpro misc driver Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 6/9] docs: misc-devices: (smpro-misc) Add documentation Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 7/9] dt-bindings: mfd: Add bindings for Ampere Altra SMPro MFD driver Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 8/9] mfd: smpro-mfd: Adds Ampere's Altra SMpro " Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen
2022-04-22 21:19   ` kernel test robot
2022-04-22 21:19     ` kernel test robot
2022-06-15 22:14   ` Lee Jones
2022-06-15 22:14     ` Lee Jones
2022-06-29  9:23   ` Quan Nguyen
2022-06-29  9:23     ` Quan Nguyen
2022-04-22  2:46 ` [PATCH v8 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces Quan Nguyen
2022-04-22  2:46   ` Quan Nguyen

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=07155685-3adf-09c8-9a13-6c8249d5fd74@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=arnd@arndb.de \
    --cc=corbet@lwn.net \
    --cc=derek.kiernan@xilinx.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dragan.cvetic@xilinx.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=jdelvare@suse.com \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=lee.jones@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=openbmc@lists.ozlabs.org \
    --cc=patches@amperecomputing.com \
    --cc=phong@os.amperecomputing.com \
    --cc=quan@os.amperecomputing.com \
    --cc=robh+dt@kernel.org \
    --cc=thang@os.amperecomputing.com \
    --cc=thu@os.amperecomputing.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.