All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
	Stephen Rothwell <sfr@canb.auug.org.au>,
	Benson Leung <bleung@google.com>,
	Guenter Roeck <groeck@chromium.org>,
	Andy Shevchenko <andy.shevchenko@gmail.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	"Rafael J . Wysocki" <rafael.j.wysocki@intel.com>,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Enric Balletbo i Serra <enric.balletbo@collabora.com>,
	Muhammad Usama Anjum <usama.anjum@collabora.com>,
	Tzung-Bi Shih <tzungbi@kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: [PATCH 1/2] platform/chrome: Use tables for values lists of ChromeOS ACPI sysfs ABI
Date: Wed, 18 May 2022 10:17:50 +0700	[thread overview]
Message-ID: <20220518031750.21923-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220518031750.21923-1-bagasdotme@gmail.com>

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/20220516213832.19127535@canb.auug.org.au/
Fixes: 0a4cad9c11ad46 ("platform/chrome: Add ChromeOS ACPI device
driver")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Benson Leung <bleung@google.com>
Cc: Guenter Roeck <groeck@chromium.org>
Cc: Andy Shevchenko <andy.shevchenko@gmail.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Enric Balletbo i Serra <enric.balletbo@collabora.com>
Cc: Muhammad Usama Anjum <usama.anjum@collabora.com>
Cc: Tzung-Bi Shih <tzungbi@kernel.org>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Cc: Linux Next Mailing List <linux-next@vger.kernel.org>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../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..cb9201548f38be 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 firmare 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


  reply	other threads:[~2022-05-18  3:19 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-18  3:17 [PATCH 0/2] platform/chrome: Documentation update for Chrome OS ACPI Bagas Sanjaya
2022-05-18  3:17 ` Bagas Sanjaya [this message]
2022-05-18  3:37   ` [PATCH 1/2] platform/chrome: Use tables for values lists of ChromeOS ACPI sysfs ABI Tzung-Bi Shih
2022-05-18  6:50     ` Bagas Sanjaya
2022-05-18  7:19       ` Tzung-Bi Shih
2022-05-18  3:17 ` [PATCH 2/2] platform/chrome: Use imperative mood for ChromeOS ACPI sysfs ABI descriptions Bagas Sanjaya

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=20220518031750.21923-2-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=andy.shevchenko@gmail.com \
    --cc=bleung@google.com \
    --cc=dmitry.torokhov@gmail.com \
    --cc=enric.balletbo@collabora.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=groeck@chromium.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=rafael.j.wysocki@intel.com \
    --cc=sfr@canb.auug.org.au \
    --cc=tzungbi@kernel.org \
    --cc=usama.anjum@collabora.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.