Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Justin Ernst <justin.ernst@hpe.com>
To:     Borislav Petkov <bp@alien8.de>,
        Hans de Goede <hdegoede@redhat.com>,
        Ingo Molnar <mingo@redhat.com>,
        Mark Gross <mgross@linux.intel.com>,
        Thomas Gleixner <tglx@linutronix.de>,
        Steve Wahl <steve.wahl@hpe.com>, x86@kernel.org
Cc:     Andy Shevchenko <andy@infradead.org>,
        Darren Hart <dvhart@infradead.org>,
        Dimitri Sivanich <dimitri.sivanich@hpe.com>,
        "H . Peter Anvin" <hpa@zytor.com>,
        Russ Anderson <russ.anderson@hpe.com>,
        linux-kernel@vger.kernel.org, platform-driver-x86@vger.kernel.org,
        Cezary Rojewski <cezary.rojewski@intel.com>,
        Ilya Dryomov <idryomov@gmail.com>,
        Jonathan Cameron <Jonathan.Cameron@huawei.com>,
        Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        Vaibhav Jain <vaibhav@linux.ibm.com>,
        Mike Travis <mike.travis@hpe.com>,
        Justin Ernst <justin.ernst@hpe.com>
Subject: [PATCH] x86/platform/uv: Fix/cleanup ABI documentation of /sys/firmware/sgi_uv/
Date:   Mon, 30 Nov 2020 15:43:04 -0600
Message-Id: <20201130214304.369348-1-justin.ernst@hpe.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

With the introduction of commit
7ac2f1017115 ("x86/platform/uv: Update ABI documentation of /sys/firmware/sgi_uv/")

3 new warnings were reported from the htmldocs build:
Documentation/ABI/testing/sysfs-firmware-sgi_uv:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-sgi_uv:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-sgi_uv:2: WARNING: Unexpected indentation.

The line number seems to be irrelevant to the location of the cause for warning.
Three new empty lines were added before codeblock sections to remove the warnings.

Lines directly before codeblock sections with one ':' get a second ':' to match
required formating.

Change an 'If' to 'It'.

This patch depends on a patch in the prior v2 patchset sent by Mike Travis <mike.travis@hpe.com>
	x86/platform/uv: Update MAINTAINERS for uv_sysfs driver

Signed-off-by: Justin Ernst <justin.ernst@hpe.com>
---
 .../ABI/testing/sysfs-firmware-sgi_uv         | 33 ++++++++++---------
 1 file changed, 18 insertions(+), 15 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-firmware-sgi_uv b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
index 1994d2621eaa..62aeb2a023f1 100644
--- a/Documentation/ABI/testing/sysfs-firmware-sgi_uv
+++ b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
@@ -5,7 +5,7 @@ Description:
 		The /sys/firmware/sgi_uv directory contains information
 		about the UV platform.
 
-		Under that directory are a number of read-only attributes:
+		Under that directory are a number of read-only attributes::
 
 			archtype
 			hub_type
@@ -16,7 +16,7 @@ Description:
 
 		The archtype entry contains the UV architecture type that
 		is used to select arch-dependent addresses and features.
-		If can be set via the OEM_ID in the ACPI MADT table or by
+		It can be set via the OEM_ID in the ACPI MADT table or by
 		UVsystab entry both passed from UV BIOS.
 
 		The hub_type entry is used to select the type of hub which is
@@ -38,7 +38,8 @@ Description:
 		this partition is in.
 
 		The uv_type entry contains the hub revision number.
-		This value can be used to identify the UV system version:
+		This value can be used to identify the UV system version::
+
 			"0.*" = Hubless UV ('*' is subtype)
 			"3.0" = UV2
 			"5.0" = UV3
@@ -46,7 +47,7 @@ Description:
 			"7.1" = UV4a
 			"9.0" = UV5
 
-		The /sys/firmware/sgi_uv directory also contains two directories:
+		The /sys/firmware/sgi_uv directory also contains two directories::
 
 			hubs/
 			pcibuses/
@@ -55,7 +56,7 @@ Description:
 		a UV Hub visible to the BIOS. Each hub object's name is appended by a
 		unique ordinal value (ex. /sys/firmware/sgi_uv/hubs/hub_5)
 
-		Each hub object directory contains a number of read-only attributes:
+		Each hub object directory contains a number of read-only attributes::
 
 			cnode
 			location
@@ -71,13 +72,15 @@ Description:
 		This value is used to physically identify a hub within a system.
 
 		The name entry contains the name of the corresponding hub. This name can
-		be two variants:
+		be two variants::
+
 			"UVHub x.x" = A 'node' ASIC, connecting a CPU to the interconnect
-				fabric. The 'x.x' value represents the ASIC revision.
-				(ex. 'UVHub 5.0')
+			fabric. The 'x.x' value represents the ASIC revision.
+			(ex. 'UVHub 5.0')
+
 			"NLxRouter" = A 'router ASIC, only connecting other ASICs to
-				the interconnect fabric. The 'x' value representing
-				the fabric technology version. (ex. 'NL8Router')
+			the interconnect fabric. The 'x' value representing
+			the fabric technology version. (ex. 'NL8Router')
 
 		The nasid entry contains the nasid number of the corresponding hub.
 		If a nasid value is not applicable, the value returned will be -1.
@@ -93,7 +96,7 @@ Description:
 		A port object's name is appended by a unique ordinal value
 		(ex. /sys/firmware/sgi_uv/hubs/hub_5/port_3)
 
-		Each port object directory contains a number of read-only attributes:
+		Each port object directory contains a number of read-only attributes::
 
 			conn_hub
 			conn_port
@@ -116,14 +119,13 @@ Description:
 				/sys/firmware/sgi_uv/hubs/hub_5/port_3/conn_port
 
 			representing that this port is connected to:
-			/sys/firmware/sgi_uv/hubs/hub_3/port_6
-
+				/sys/firmware/sgi_uv/hubs/hub_3/port_6
 
 		The pcibuses directory contains a number of PCI bus objects.
 		Each PCI bus object's name is appended by its PCI bus address.
 		(ex. pcibus_0003:80)
 
-		Each pcibus object has a number of possible read-only attributes:
+		Each pcibus object has a number of possible read-only attributes::
 
 			type
 			location
@@ -133,7 +135,8 @@ Description:
 
 		The type entry contains a value describing the type of IO at
 		the corresponding PCI bus address. Known possible values
-		across all UV versions are:
+		across all UV versions are::
+
 			BASE IO
 			PCIe IO
 			PCIe SLOT
-- 
2.26.2