Sender: Guenter Roeck <groeck7@gmail.com>
Subject: Re: [PATCH 3/4] docs: hwmon: dell-smm-hwmon.rst: Replace ascii table
 with flat-table
To:     Armin Wolf <W_Armin@gmx.de>, pali@kernel.org
Cc:     jdelvare@suse.com, corbet@lwn.net, linux-doc@vger.kernel.org,
        linux-hwmon@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20211228153709.18317-1-W_Armin@gmx.de>
 <20211228153709.18317-3-W_Armin@gmx.de>
From:   Guenter Roeck <linux@roeck-us.net>
Message-ID: <3e2be661-093f-fe75-465b-1cc54e0d9f22@roeck-us.net>
Date:   Tue, 28 Dec 2021 07:54:05 -0800
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.14.0
MIME-Version: 1.0
In-Reply-To: <20211228153709.18317-3-W_Armin@gmx.de>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 12/28/21 7:37 AM, Armin Wolf wrote:
> flat-table is recommended over ascii art tables.
> 

I really don't want to encourage people sending me such patches,
so please don't do that unless there is a technical reason
to make those changes.

Guenter

> 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
>