| Message ID | 20211228153709.18317-3-W_Armin@gmx.de (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [1/4] Documentation: admin-guide: Update i8k driver name | expand |
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 >
Armin Wolf <W_Armin@gmx.de> writes: > 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(-) FWIW, I totally disagree with that recommendation and should really just take it out. This patch makes it clear why: the new table is almost entirely unreadable in the plain-text form. Thanks, jon
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 ------------------------------------
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(-) -- 2.30.2