Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     linux-doc@vger.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@gmail.com>,
        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 v2 2/2] platform/chrome: Use imperative mood for ChromeOS ACPI sysfs ABI descriptions
Date:   Wed, 18 May 2022 15:35:24 +0700
Message-Id: <20220518083524.37380-3-bagasdotme@gmail.com>
In-Reply-To: <20220518083524.37380-1-bagasdotme@gmail.com>
References: <20220518083524.37380-1-bagasdotme@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

The current descriptions all begin with ("This file shows something")
clause, which is incorrect wording since these mean return value from
sysfs.

Use imperative mood ("Returns something") instead, in line with
corresponding ACPI documentation at firmware-guide/.

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    | 63 +++++++++----------
 1 file changed, 30 insertions(+), 33 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-driver-chromeos-acpi b/Documentation/ABI/testing/sysfs-driver-chromeos-acpi
index cce45395170079..c308926e1568a7 100644
--- a/Documentation/ABI/testing/sysfs-driver-chromeos-acpi
+++ b/Documentation/ABI/testing/sysfs-driver-chromeos-acpi
@@ -2,8 +2,7 @@ What:		/sys/bus/platform/devices/GGL0001:*/BINF.2
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows information about the current boot of
-		the active EC firmware.
+		Returns active EC firmware of current boot (boolean).
 
 		== ===============================
 		0  Read only (recovery) firmware.
@@ -14,8 +13,7 @@ What:		/sys/bus/platform/devices/GGL0001:*/BINF.3
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows information about the current boot of
-		the active main	firmware type.
+		Returns main firmware type for current boot (integer).
 
 		== =====================================
 		0  Recovery.
@@ -28,8 +26,8 @@ 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 when the firmware is booted.
+		Returns switch position for Chrome OS specific hardware
+		switches when the firmware is booted (integer).
 
 		==== ===========================================
 		0    No changes.
@@ -43,29 +41,29 @@ What:		/sys/bus/platform/devices/GGL0001:*/FMAP
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the physical memory address of the start of
-		the main processor firmware flashmap.
+		Returns physical memory address of the start of the main
+		processor firmware flashmap.
 
 What:		/sys/bus/platform/devices/GGL0001:*/FRID
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the firmware version for the read-only portion
-		of the main processor firmware.
+		Returns firmware version for the read-only portion of the
+		main processor firmware.
 
 What:		/sys/bus/platform/devices/GGL0001:*/FWID
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the firmware version for the rewritable portion
-		of the main processor firmware.
+		Returns firmware version for the rewritable portion of the
+		main processor firmware.
 
 What:		/sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.0
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the type of the GPIO signal for the Chrome OS
-		specific GPIO assignments.
+		Returns type of the GPIO signal for the Chrome OS specific
+		GPIO assignments (integer).
 
 		=========== ==================================
 		1           Recovery button.
@@ -78,7 +76,7 @@ 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.
+		Returns signal attributes of the GPIO signal (integer bitfield).
 
 		== =======================
 		0  Signal is active low.
@@ -89,52 +87,51 @@ What:		/sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.2
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the GPIO number on the specified GPIO
+		Returns the GPIO number on the specified GPIO
 		controller.
 
 What:		/sys/bus/platform/devices/GGL0001:*/GPIO.X/GPIO.3
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the name of the GPIO controller.
+		Returns name of the GPIO controller.
 
 What:		/sys/bus/platform/devices/GGL0001:*/HWID
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the hardware ID for the Chromebook.
+		Returns hardware ID for the Chromebook.
 
 What:		/sys/bus/platform/devices/GGL0001:*/MECK
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This binary file returns the SHA-1 or SHA-256 hash that is
-		read out of the Management Engine extended registers during
-		boot. The hash is exported vi ACPI so the OS can verify that
-		the Management Engine firmware has not changed. If Management
-		Engine is not present, or if the firmware was unable to read the
-		extended registers, this buffer size can be zero.
+		Returns the SHA-1 or SHA-256 hash that is read out of the
+		Management Engine extended registers during boot. The hash
+		is exported via ACPI so the OS can verify that the Management
+		Engine firmware has not changed. If Management Engine is not
+		present, or if the firmware was unable to read the extended registers, this buffer size can be zero.
 
 What:		/sys/bus/platform/devices/GGL0001:*/VBNV.0
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the offset in CMOS bank 0 of the verified boot
-		non-volatile storage block, counting from the first writable
-		CMOS byte (that is, 'offset = 0' is the byte following the 14
-		bytes of clock data).
+		Returns offset in CMOS bank 0 of the verified boot non-volatile
+		storage block, counting from the first writable CMOS byte
+		(that is, 'offset = 0' is the byte following the 14 bytes of
+		clock data).
 
 What:		/sys/bus/platform/devices/GGL0001:*/VBNV.1
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This file shows the size in bytes of the verified boot
-		non-volatile storage block.
+		Return the size in bytes of the verified boot non-volatile
+		storage block.
 
 What:		/sys/bus/platform/devices/GGL0001:*/VDAT
 Date:		May 2022
 KernelVersion:	5.19
 Description:
-		This binary file returns the verified boot data block shared
-		between the firmware verification step and the kernel
-		verification step.
+		Returns the verified boot data block shared between the
+		firmware verification step and the kernel verification step
+		(binary).
-- 
An old man doll... just what I always wanted! - Clara