mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Armin Wolf <W_Armin@gmx.de>
To: pali@kernel.org
Cc: jdelvare@suse.com, linux@roeck-us.net, corbet@lwn.net,
	linux-doc@vger.kernel.org, linux-hwmon@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH 3/4] docs: hwmon: dell-smm-hwmon.rst: Replace ascii table with flat-table
Date: Tue, 28 Dec 2021 16:37:08 +0100	[thread overview]
Message-ID: <20211228153709.18317-3-W_Armin@gmx.de> (raw)
In-Reply-To: <20211228153709.18317-1-W_Armin@gmx.de>

flat-table is recommended over ascii art tables.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
---
 Documentation/hwmon/dell-smm-hwmon.rst | 60 +++++++++++++++++++-------
 1 file changed, 44 insertions(+), 16 deletions(-)

diff --git a/Documentation/hwmon/dell-smm-hwmon.rst b/Documentation/hwmon/dell-smm-hwmon.rst
index beec88491171..f1e185e8a3f7 100644
--- a/Documentation/hwmon/dell-smm-hwmon.rst
+++ b/Documentation/hwmon/dell-smm-hwmon.rst
@@ -29,22 +29,50 @@ Temperature sensors and fans can be queried and set via the standard
 ``X`` such that ``/sys/class/hwmon/hwmonX/name`` has content
 ``dell_smm``). A number of other attributes can be read or written:

-=============================== ======= =======================================
-Name				Perm	Description
-=============================== ======= =======================================
-fan[1-3]_input                  RO      Fan speed in RPM.
-fan[1-3]_label                  RO      Fan label.
-fan[1-3]_min                    RO      Minimal Fan speed in RPM
-fan[1-3]_max                    RO      Maximal Fan speed in RPM
-fan[1-3]_target                 RO      Expected Fan speed in RPM
-pwm[1-3]                        RW      Control the fan PWM duty-cycle.
-pwm1_enable                     WO      Enable or disable automatic BIOS fan
-                                        control (not supported on all laptops,
-                                        see below for details).
-temp[1-10]_input                RO      Temperature reading in milli-degrees
-                                        Celsius.
-temp[1-10]_label                RO      Temperature sensor label.
-=============================== ======= =======================================
+.. flat-table::
+   :header-rows: 1
+   :widths: 4 1 5
+
+   * - Name
+     - Perm
+     - Description
+
+   * - fan[1-3]_input
+     - RO
+     - Fan speed in RPM
+
+   * - fan[1-3]_label
+     - RO
+     - Fan label
+
+   * - fan[1-3]_min
+     - RO
+     - Minimal Fan speed in RPM
+
+   * - fan[1-3]_max
+     - RO
+     - Maximal Fan speed in RPM
+
+   * - fan[1-3]_target
+     - RO
+     - Expected Fan speed in RPM
+
+   * - pwm[1-3]
+     - RW
+     - Control the fan PWM duty-cycle
+
+   * - pwm1_enable
+     - WO
+     - Enable or disable automatic BIOS fan control (not supported
+       on all laptops, see below for details)
+
+   * - temp[1-10]_input
+     - RO
+     - Temperature reading in milli-degrees Celsius
+
+   * - temp[1-10]_label
+     - RO
+     - Temperature sensor label

 Disabling automatic BIOS fan control
 ------------------------------------
--
2.30.2


  parent reply	other threads:[~2021-12-28 15:37 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-28 15:37 [PATCH 1/4] Documentation: admin-guide: Update i8k driver name Armin Wolf
2021-12-28 15:37 ` [PATCH 2/4] Documentation: admin-guide: Add Documentation for undocumented dell_smm_hwmon parameters Armin Wolf
2021-12-28 15:37 ` Armin Wolf [this message]
2021-12-28 15:54   ` [PATCH 3/4] docs: hwmon: dell-smm-hwmon.rst: Replace ascii table with flat-table Guenter Roeck
2021-12-29 15:23   ` Jonathan Corbet
2021-12-28 15:37 ` [PATCH 4/4] Documentation: ABI: Add ABI file for legacy /proc/i8k interface Armin Wolf

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=20211228153709.18317-3-W_Armin@gmx.de \
    --to=w_armin@gmx.de \
    --cc=corbet@lwn.net \
    --cc=jdelvare@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=pali@kernel.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®