Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Quan Nguyen <quan@os.amperecomputing.com>
To:     Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Jonathan Corbet <corbet@lwn.net>,
        Open Source Submission <patches@amperecomputing.com>
Cc:     Bagas Sanjaya <bagasdotme@gmail.com>, linux-hwmon@vger.kernel.org,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        Phong Vo <phong@os.amperecomputing.com>,
        thang@os.amperecomputing.com, openbmc@lists.ozlabs.org,
        Quan Nguyen <quan@os.amperecomputing.com>
Subject: [PATCH] docs: hwmon: (smpro-hwmon) Improve grammar and formatting
Date:   Wed,  2 Nov 2022 13:21:03 +0700
Message-Id: <20221102062103.3135417-1-quan@os.amperecomputing.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?xp5euZGUHsLN/pX/io6PTgtnIi5SOuQjGT44nMM4yQs8t00pL3L3TFWaBpa3?=
 =?us-ascii?Q?7M7CcAfMSe5mNVWIPnsL8hNprCfvS6eilGc5uNHtgvU3Ua6iR7eN+eM9WVJA?=
 =?us-ascii?Q?SHGB6ng06fDikjDxsitQ12jmZVcXieOXXNSBcqFOAQXNu4ZZxddw9mNrW8u+?=
 =?us-ascii?Q?2SqlS5I8/XyQM+jLvJudmn6FE8ZNmZleb+2iDJKXptp1dd6zELoEZU0hrqMV?=
 =?us-ascii?Q?g/vCflixGGlTc8ulXso3T0goKezirNNSeUNabLVWkaXc00Bnfzu85qaGIlmm?=
 =?us-ascii?Q?iEMcBMxC0vm/aq0+KnPOxMG5Xhu41zTKCJnI0oAjtTauR0D6dwxCGpgp7KUD?=
 =?us-ascii?Q?d70b7JmJSOvYkNScNBZJlHHFEi0nQXvrbglhPVQ5SXBPPPsXPhpN8qN4xlVo?=
 =?us-ascii?Q?X9jBBKxGnL10s4N0pDMWk0CWsRio4K6/dOhTO7oIU8okzQoaKfcWI9DDfKiG?=
 =?us-ascii?Q?Oc7mAQk9kZC23mInRYBINWuGobTkaHjN5AftKH8h2BM5MR/14vleIQY6IEug?=
 =?us-ascii?Q?tmx1xH890WhmO2Qzr1h+JOF0xltqwagAU+lLEvbPNqUjUbcg7sxLPcuqE2WM?=
 =?us-ascii?Q?G9DTfaZWg9SoO5eqHwMDP1xapYtRFVJCttpjW7AuDGQOFFYjpc4+B5lUrAku?=
 =?us-ascii?Q?ILY45qisIiN/GFtN1LvyQ+wdA9g+J12e0m8f7h2QA4bfAqPjvAcY416h9wxj?=
 =?us-ascii?Q?P78TWb5GpP+tX/5lXA0HeA+D5wOpecE8S1RVKZ0zYM0GMJ7unnGVcw6DAVoh?=
 =?us-ascii?Q?8gOrEXimuLvsIXFNwdWDlUp4AjGaEchWzGhwjneQUy4Zk+z5VgvRlJuwgbrl?=
 =?us-ascii?Q?8zxZTFkZCw0m8Gaapi+umtT7pREY7Yc4OiWtOrBlOmFpydrW1s/xBibYtKwX?=
 =?us-ascii?Q?FGN62J3FVX0Od2RgkDA6fxe1r3zLiBGZR7Uw17AOw5IUHD2XVYJAVWUsyruW?=
 =?us-ascii?Q?OiIfGQWH/fQ4kfeo9s3VlDq6r+Lfo2lsq1tIjtjs/3hFKmNzWCYp4874vt52?=
 =?us-ascii?Q?BitZUXaQBWtY7zIoOx5XN+XtQ14EcT4GI3ek4YUxByQzcevae0763Td9A4P6?=
 =?us-ascii?Q?nmmr8Rdk2PdRSkX/U8lsokN/qJtG0myUUaDuev4/tPJ51UoBkPw1C+yU8clJ?=
 =?us-ascii?Q?PhIlWfEQ0KFEgWcyBPxcPVR1N2/sZzCVD3FCuZ3ZMJqMWZvqyGcTPCjJHXVv?=
 =?us-ascii?Q?7kxp8N5SQktOl8HephcQ5ylQ79d3QTDwUEM00D5fN41OejU6lxcYph55kRdb?=
 =?us-ascii?Q?Q4slHUr2F9CDvd2+QBU2OUYF6cxvLtiUbyGYZziT13qgOYth4OUQOmJQAumD?=
 =?us-ascii?Q?11IERfUWIdPM1bcj8Bfqv2Rq7AybW+sFBJu07FPgjQ3HjRFFntQjXx7Q7iKP?=
 =?us-ascii?Q?ws7iDaklu0hCuwHIpwSYNjUBMpN0zBKpawIfb6gtQVCJzc1IlOc4EA8JLmJ9?=
 =?us-ascii?Q?vYFgupPEOxH3X7NWKtPFVL3M689mii5jrIuizIbz2rjHEQZt99FYydG2efGa?=
 =?us-ascii?Q?SRLyetDcML+BLDWZ2yZBqz96xC9U0eMx+ilWhf9JM4bLIoG72gjqSqtzqZm1?=
 =?us-ascii?Q?Oxis4b/5dn3IDR0cSahHRWkusD658XyKbiCBpuryPXWoFHFO3rZCvRqAIlj2?=
 =?us-ascii?Q?iMDQLFNiekyHhY5wWpk4y/Q=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1aa1f40b-e7bd-463c-e544-08dabc9a83e7
X-MS-Exchange-CrossTenant-AuthSource: SN4PR01MB7455.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 02 Nov 2022 06:21:45.5707
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: /HIPs8vPYyhdp/JRhhay8eiNpEqfzrIzvYmNrVF5tumBsLuxpdObngW8/oc/C65xPsRrytgHeDEEsZ3mVooAQNwapYlmlLcuVf5L4iApPk8=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR01MB3835
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,
        SPF_HELO_PASS,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Improve documentation grammar and formatting for the
Ampere(R)'s Altra(R) SMpro hwmon driver.

Thanks Bagas for the changes in the link below.

Link: https://lore.kernel.org/lkml/Y1aHiaZ1OpHZIzS9@google.com/T/#mfea2167b99384486a1b75d9304536015116c1821
Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
---
 Documentation/hwmon/smpro-hwmon.rst | 111 ++++++++++++++--------------
 1 file changed, 56 insertions(+), 55 deletions(-)

diff --git a/Documentation/hwmon/smpro-hwmon.rst b/Documentation/hwmon/smpro-hwmon.rst
index 3a9b14dacf89..fb7b3665735b 100644
--- a/Documentation/hwmon/smpro-hwmon.rst
+++ b/Documentation/hwmon/smpro-hwmon.rst
@@ -7,39 +7,39 @@ Supported chips:
 
   * Ampere(R) Altra(R)
 
-    Prefix: 'smpro'
+    Prefix: ``smpro``
 
-    Reference: Altra SoC BMC Interface Specification
+    Reference: `Altra SoC BMC Interface Specification`
 
 Author: Thu Nguyen <thu@os.amperecomputing.com>
 
 Description
 -----------
-This driver supports hardware monitoring for Ampere(R) Altra(R) SoC's based on the
-SMpro co-processor (SMpro).
-The following sensor types are supported by the driver:
+The smpro-hwmon driver supports hardware monitoring for Ampere(R) Altra(R)
+SoCs based on the SMpro co-processor (SMpro).  The following sensor metrics
+are supported by the driver:
 
   * temperature
   * voltage
   * current
   * power
 
-The SMpro interface provides the registers to query the various sensors and
+The interface provides the registers to query the various sensors and
 their values which are then exported to userspace by this driver.
 
 Usage Notes
 -----------
 
-SMpro hwmon driver creates at least two sysfs files for each sensor.
+The driver creates at least two sysfs files for each sensor.
 
-* File ``<sensor_type><idx>_label`` reports the sensor label.
-* File ``<sensor_type><idx>_input`` returns the sensor value.
+* ``<sensor_type><idx>_label`` reports the sensor label.
+* ``<sensor_type><idx>_input`` returns the sensor value.
 
-The sysfs files are allocated in the SMpro root fs folder.
-There is one root folder for each SMpro instance.
+The sysfs files are allocated in the SMpro rootfs folder, with one root
+directory for each instance.
 
-When the SoC is turned off, the driver will fail to read registers
-and return -ENXIO.
+When the SoC is turned off, the driver will fail to read registers and
+return ``-ENXIO``.
 
 Sysfs entries
 -------------
@@ -48,48 +48,49 @@ The following sysfs files are supported:
 
 * Ampere(R) Altra(R):
 
-============    =============   ======  ===============================================
-Name            Unit            Perm    Description
-temp1_input     milli Celsius   RO      SoC temperature
-temp2_input     milli Celsius   RO      Max temperature reported among SoC VRDs
-temp2_crit      milli Celsius   RO      SoC VRD HOT Threshold temperature
-temp3_input     milli Celsius   RO      Max temperature reported among DIMM VRDs
-temp4_input     milli Celsius   RO      Max temperature reported among Core VRDs
-temp5_input     milli Celsius   RO      Temperature of DIMM0 on CH0
-temp5_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp6_input     milli Celsius   RO      Temperature of DIMM0 on CH1
-temp6_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp7_input     milli Celsius   RO      Temperature of DIMM0 on CH2
-temp7_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp8_input     milli Celsius   RO      Temperature of DIMM0 on CH3
-temp8_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp9_input     milli Celsius   RO      Temperature of DIMM0 on CH4
-temp9_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp10_input    milli Celsius   RO      Temperature of DIMM0 on CH5
-temp10_crit     milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp11_input    milli Celsius   RO      Temperature of DIMM0 on CH6
-temp11_crit     milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp12_input    milli Celsius   RO      Temperature of DIMM0 on CH7
-temp12_crit     milli Celsius   RO      MEM HOT Threshold for all DIMMs
-temp13_input    milli Celsius   RO      Max temperature reported among RCA VRDs
-in0_input       milli Volts     RO      Core voltage
-in1_input       milli Volts     RO      SoC voltage
-in2_input       milli Volts     RO      DIMM VRD1 voltage
-in3_input       milli Volts     RO      DIMM VRD2 voltage
-in4_input       milli Volts     RO      RCA VRD voltage
-cur1_input      milli Amperes   RO      Core VRD current
-cur2_input      milli Amperes   RO      SoC VRD current
-cur3_input      milli Amperes   RO      DIMM VRD1 current
-cur4_input      milli Amperes   RO      DIMM VRD2 current
-cur5_input      milli Amperes   RO      RCA VRD current
-power1_input    micro Watts     RO      Core VRD power
-power2_input    micro Watts     RO      SoC VRD power
-power3_input    micro Watts     RO      DIMM VRD1 power
-power4_input    micro Watts     RO      DIMM VRD2 power
-power5_input    micro Watts     RO      RCA VRD power
-============    =============   ======  ===============================================
-
-Example::
+  ============    =============  ======  ===============================================
+  Name            Unit           Perm    Description
+  ============    =============  ======  ===============================================
+  temp1_input     millicelsius   RO      SoC temperature
+  temp2_input     millicelsius   RO      Max temperature reported among SoC VRDs
+  temp2_crit      millicelsius   RO      SoC VRD HOT Threshold temperature
+  temp3_input     millicelsius   RO      Max temperature reported among DIMM VRDs
+  temp4_input     millicelsius   RO      Max temperature reported among Core VRDs
+  temp5_input     millicelsius   RO      Temperature of DIMM0 on CH0
+  temp5_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp6_input     millicelsius   RO      Temperature of DIMM0 on CH1
+  temp6_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp7_input     millicelsius   RO      Temperature of DIMM0 on CH2
+  temp7_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp8_input     millicelsius   RO      Temperature of DIMM0 on CH3
+  temp8_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp9_input     millicelsius   RO      Temperature of DIMM0 on CH4
+  temp9_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp10_input    millicelsius   RO      Temperature of DIMM0 on CH5
+  temp10_crit     millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp11_input    millicelsius   RO      Temperature of DIMM0 on CH6
+  temp11_crit     millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp12_input    millicelsius   RO      Temperature of DIMM0 on CH7
+  temp12_crit     millicelsius   RO      MEM HOT Threshold for all DIMMs
+  temp13_input    millicelsius   RO      Max temperature reported among RCA VRDs
+  in0_input       millivolts     RO      Core voltage
+  in1_input       millivolts     RO      SoC voltage
+  in2_input       millivolts     RO      DIMM VRD1 voltage
+  in3_input       millivolts     RO      DIMM VRD2 voltage
+  in4_input       millivolts     RO      RCA VRD voltage
+  cur1_input      milliamperes   RO      Core VRD current
+  cur2_input      milliamperes   RO      SoC VRD current
+  cur3_input      milliamperes   RO      DIMM VRD1 current
+  cur4_input      milliamperes   RO      DIMM VRD2 current
+  cur5_input      milliamperes   RO      RCA VRD current
+  power1_input    microwatts     RO      Core VRD power
+  power2_input    microwatts     RO      SoC VRD power
+  power3_input    microwatts     RO      DIMM VRD1 power
+  power4_input    microwatts     RO      DIMM VRD2 power
+  power5_input    microwatts     RO      RCA VRD power
+  ============    =============  ======  ===============================================
+
+  Example::
 
     # cat in0_input
     830
-- 
2.35.1