Subject: [PATCH v2 1/2] platform/chrome: Use tables for values lists of ChromeOS ACPI sysfs ABI

From: Bagas Sanjaya <[email-masked]>
Date: Wed, 18 May 2022 15:35:23 +0700

Stephen Rothwell reported htmldocs warning when merging chrome-platform
tree:

Documentation/ABI/testing/sysfs-driver-chromeos-acpi:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-driver-chromeos-acpi:11: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-driver-chromeos-acpi:22: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-driver-chromeos-acpi:56: WARNING: Unexpected indentation.

The warning is due to missing blank line separator surrounding values
lists.

Instead of using lists, use tables to be consistent with rest of sysfs
ABI documentation.

Link: https://lore.kernel.org/linux-next/[email-masked]/
Fixes: 0a4cad9c11ad46 ("platform/chrome: Add ChromeOS ACPI device
driver")
Reported-by: Stephen Rothwell <[email-masked]>
Cc: Benson Leung <[email-masked]>
Cc: Guenter Roeck <[email-masked]>
Cc: Andy Shevchenko <[email-masked]>
Cc: Greg Kroah-Hartman <[email-masked]>
Cc: Rafael J. Wysocki <[email-masked]>
Cc: Dmitry Torokhov <[email-masked]>
Cc: Enric Balletbo i Serra <[email-masked]>
Cc: Muhammad Usama Anjum <[email-masked]>
Cc: Tzung-Bi Shih <[email-masked]>
Cc: Linux Kernel Mailing List <[email-masked]>
Cc: Linux Next Mailing List <[email-masked]>
Signed-off-by: Bagas Sanjaya <[email-masked]>
---
 .../ABI/testing/sysfs-driver-chromeos-acpi    | 52 ++++++++++++-------
 1 file changed, 33 insertions(+), 19 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-driver-chromeos-acpi b/Documentation/ABI/testing/sysfs-driver-chromeos-acpi
index 5b59ef9d7b371c..cce45395170079 100644
--- a/Documentation/ABI/testing/sysfs-driver-chromeos-acpi
+++ b/Documentation/ABI/testing/sysfs-driver-chromeos-acpi
@@ -4,8 +4,11 @@ KernelVersion:	5.19
 Description:
 		This file shows information about the current boot of
 		the active EC firmware.
-		  * 0 - Read only (recovery) firmware.
-		  * 1 - Rewritable firmware.
+
+		== ===============================
+		0  Read only (recovery) firmware.
+		1  Rewritable firmware.
+		== ===============================
 
 What:		/sys/bus/platform/devices/GGL0001:*/BINF.3
 Date:		May 2022
@@ -13,23 +16,28 @@ KernelVersion:	5.19
 Description:
 		This file shows information about the current boot of
 		the active main	firmware type.
-		  * 0 - Recovery.
-		  * 1 - Normal.
-		  * 2 - Developer.
-		  * 3 - Netboot (factory installation only).
+
+		== =====================================
+		0  Recovery.
+		1  Normal.
+		2  Developer.
+		3  Netboot (factory installation only).
+		== =====================================
 
 What:		/sys/bus/platform/devices/GGL0001:*/CHSW
 Date:		May 2022
 KernelVersion:	5.19
 Description:
 		This file shows the switch position for the Chrome OS specific
-		hardware switches.
-		  * 0   - No changes.
-		  * 2   - Recovery button was pressed when firmware booted.
-		  * 4   - Recovery button was pressed when EC firmware booted.
-		  * 32  - Developer switch was enabled when firmware booted.
-		  * 512 - Firmware write protection was disabled when firmware
-			  booted.
+		hardware switches when the firmware is booted.
+
+		==== ===========================================
+		0    No changes.
+		2    Recovery button was pressed.
+		4    Recovery button was pressed (EC firmware).
+		32   Developer switch was enabled.
+		512  Firmware write protection was disabled.
+		==== ===========================================
 
 What:		/sys/bus/platform/devices/GGL0001:*/FMAP
 Date:		May 2022
@@ -58,18 +66,24 @@ KernelVersion:	5.19
 Description:
 		This file shows the type of the GPIO signal for the Chrome OS
 		specific GPIO assignments.
-		  * 1   - Recovery button.
-		  * 2   - Developer mode switch.
-		  * 3   - Firmware write protection switch.
-		  * 256 to 511 - Debug header GPIO 0 to GPIO 255.
+
+		=========== ==================================
+		1           Recovery button.
+		2           Developer mode switch.
+		3           Firmware write protection switch.
+		256 to 511  Debug header GPIO 0 to GPIO 255.
+		=========== ==================================
 
 What:		/sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.1
 Date:		May 2022
 KernelVersion:	5.19
 Description:
 		This file shows the signal attributes of the GPIO signal.
-		  * 0 - Signal is active low.
-		  * 1 - Signal is active high.
+
+		== =======================
+		0  Signal is active low.
+		1  Signal is active high.
+		== =======================
 
 What:		/sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.2
 Date:		May 2022
-- 
An old man doll... just what I always wanted! - Clara