diff mbox series

docs: hmon: ltc2978.rst: fix a broken table

Message ID 9188836b1ec6744d3d936df8fbfe08f25422879e.1581610553.git.mchehab+huawei@kernel.org (mailing list archive)
State Not Applicable
Headers show
Series docs: hmon: ltc2978.rst: fix a broken table | expand

Commit Message

Mauro Carvalho Chehab Feb. 13, 2020, 4:15 p.m. UTC 
/devel/v4l/docs/Documentation/hwmon/ltc2978.rst:320: WARNING: Malformed table.
Text in column margin in table line 80.

Cc: Mike Jones <michael-a1.jones@analog.com>
Fixes: 6d36d475215a ("hwmon: (pmbus/ltc2978) add support for more parts.")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/hwmon/ltc2978.rst | 50 ++++++++++++++++-----------------
 1 file changed, 25 insertions(+), 25 deletions(-)

Comments

Guenter Roeck Feb. 13, 2020, 4:24 p.m. UTC | #1 
On Thu, Feb 13, 2020 at 05:15:55PM +0100, Mauro Carvalho Chehab wrote:
> /devel/v4l/docs/Documentation/hwmon/ltc2978.rst:320: WARNING: Malformed table.
> Text in column margin in table line 80.
> 
> Cc: Mike Jones <michael-a1.jones@analog.com>
> Fixes: 6d36d475215a ("hwmon: (pmbus/ltc2978) add support for more parts.")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Sorry, I may have messed that up when trying to fix lines exceeding 
80 columns in that file. The problem is already fixed in -next.

Guenter
Jones, Michael-A1 Feb. 13, 2020, 4:38 p.m. UTC | #2 
-----Original Message-----
From: Guenter Roeck <groeck7@gmail.com> On Behalf Of Guenter Roeck
Sent: Thursday, February 13, 2020 9:24 AM
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>; Jonathan Corbet <corbet@lwn.net>; Jean Delvare <jdelvare@suse.com>; Jones, Michael-A1 <Michael-A1.Jones@analog.com>; linux-hwmon@vger.kernel.org
Subject: Re: [PATCH] docs: hmon: ltc2978.rst: fix a broken table

[External]

On Thu, Feb 13, 2020 at 05:15:55PM +0100, Mauro Carvalho Chehab wrote:
> /devel/v4l/docs/Documentation/hwmon/ltc2978.rst:320: WARNING: Malformed table.
> Text in column margin in table line 80.
> 
> Cc: Mike Jones <michael-a1.jones@analog.com>
> Fixes: 6d36d475215a ("hwmon: (pmbus/ltc2978) add support for more parts.")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Sorry, I may have messed that up when trying to fix lines exceeding 
80 columns in that file. The problem is already fixed in -next.

MJ: I would like to know what tool produced the warning so I can run it next time before submission.

Guenter
Randy Dunlap Feb. 13, 2020, 4:52 p.m. UTC | #3 
On 2/13/20 8:38 AM, Jones, Michael-A1 wrote:
> 
> 
> -----Original Message-----
> From: Guenter Roeck <groeck7@gmail.com> On Behalf Of Guenter Roeck
> Sent: Thursday, February 13, 2020 9:24 AM
> To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>; Jonathan Corbet <corbet@lwn.net>; Jean Delvare <jdelvare@suse.com>; Jones, Michael-A1 <Michael-A1.Jones@analog.com>; linux-hwmon@vger.kernel.org
> Subject: Re: [PATCH] docs: hmon: ltc2978.rst: fix a broken table
> 
> [External]
> 
> On Thu, Feb 13, 2020 at 05:15:55PM +0100, Mauro Carvalho Chehab wrote:
>> /devel/v4l/docs/Documentation/hwmon/ltc2978.rst:320: WARNING: Malformed table.
>> Text in column margin in table line 80.
>>
>> Cc: Mike Jones <michael-a1.jones@analog.com>
>> Fixes: 6d36d475215a ("hwmon: (pmbus/ltc2978) add support for more parts.")
>> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> 
> Sorry, I may have messed that up when trying to fix lines exceeding 
> 80 columns in that file. The problem is already fixed in -next.
> 
> MJ: I would like to know what tool produced the warning so I can run it next time before submission.

Hi,

To see only hwmon docs build, do this (I capture the output to a file;
I also use a separate build dir for DOCS):

$ cd linux-5.6-rc1

$ mkdir -p DOCS

$ make SPHINXDIRS="hwmon" O=DOCS htmldocs 2>&1 | tee dochwmon.out

and then search thru dochwmon.out for files or subjects that
you are interested in.
diff mbox series

Patch

diff --git a/Documentation/hwmon/ltc2978.rst b/Documentation/hwmon/ltc2978.rst
index 58838d48354c..0db5561b48cd 100644
--- a/Documentation/hwmon/ltc2978.rst
+++ b/Documentation/hwmon/ltc2978.rst
@@ -248,12 +248,12 @@  in1_min			Minimum input voltage.
 in1_max			Maximum input voltage.
 
 			LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
-      LTC2979 and LTM2987 only.
+			LTC2979 and LTM2987 only.
 
 in1_lcrit		Critical minimum input voltage.
 
 			LTC2972, LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
-      LTC2979 and LTM2987 only.
+			LTC2979 and LTM2987 only.
 
 in1_crit		Critical maximum input voltage.
 
@@ -262,11 +262,11 @@  in1_min_alarm		Input voltage low alarm.
 in1_max_alarm		Input voltage high alarm.
 
 			LTC2972, LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
-      LTC2979 and LTM2987 only.
+			LTC2979 and LTM2987 only.
 in1_lcrit_alarm		Input voltage critical low alarm.
 
 			LTC2972, LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
-      LTC2979 and LTM2987 only.
+			LTC2979 and LTM2987 only.
 in1_crit_alarm		Input voltage critical high alarm.
 
 in1_lowest		Lowest input voltage.
@@ -279,13 +279,13 @@  in1_reset_history	Reset input voltage history.
 
 in[N]_label		"vout[1-8]".
 
-      - LTC2972: N=2-3
+			- LTC2972: N=2-3
 			- LTC2974, LTC2975: N=2-5
 			- LTC2977, LTC2979, LTC2980, LTM2987: N=2-9
 			- LTC2978: N=2-9
 			- LTC3880, LTC3882, LTC3884, LTC23886 LTC3887, LTC3889,
-        LTC7880, LTM4644, LTM4675, LTM4676, LTM4677, LTM4678,
-        LTM4680, LTM4700: N=2-3
+			  LTC7880, LTM4644, LTM4675, LTM4676, LTM4677, LTM4678,
+			  LTM4680, LTM4700: N=2-3
 			- LTC3883: N=2
 
 in[N]_input		Measured output voltage.
@@ -317,24 +317,24 @@  in[N]_reset_history	Reset output voltage history.
 
 temp[N]_input		Measured temperature.
 
-      - On LTC2972, temp[1-2] report external temperatures,
-        and temp 3 reports the chip temperature.
+			- On LTC2972, temp[1-2] report external temperatures,
+			  and temp 3 reports the chip temperature.
 			- On LTC2974 and LTC2975, temp[1-4] report external
 			  temperatures, and temp5 reports the chip temperature.
 			- On LTC2977, LTC2979, LTC2980, LTC2978, and LTM2987,
-        only one temperature measurement is supported and
-        reports the chip temperature.
+			  only one temperature measurement is supported and
+			  reports the chip temperature.
 			- On LTC3880, LTC3882, LTC3886, LTC3887, LTC3889,
-        LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
-        and LTM4700, temp1 and temp2 report external
-        temperatures, and temp3 reports the chip temperature.
+			  LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
+			  and LTM4700, temp1 and temp2 report external
+			  temperatures, and temp3 reports the chip temperature.
 			- On LTC3883, temp1 reports an external temperature,
 			  and temp2 reports the chip temperature.
 
 temp[N]_min		Mimimum temperature.
 
 			LTC2972, LTC2974, LCT2977, LTM2980, LTC2978,
-      LTC2979, and LTM2987 only.
+			LTC2979, and LTM2987 only.
 
 temp[N]_max		Maximum temperature.
 
@@ -345,7 +345,7 @@  temp[N]_crit		Critical high temperature.
 temp[N]_min_alarm	Temperature low alarm.
 
 			LTC2972, LTC2974, LTC2975, LTC2977, LTM2980, LTC2978,
-      LTC2979, and LTM2987 only.
+			LTC2979, and LTM2987 only.
 
 temp[N]_max_alarm	Temperature high alarm.
 
@@ -357,7 +357,7 @@  temp[N]_crit_alarm	Temperature critical high alarm.
 temp[N]_lowest		Lowest measured temperature.
 
 			- LTC2972, LTC2974, LTC2975, LTC2977, LTM2980, LTC2978,
-        LTC2979, and LTM2987 only.
+			  LTC2979, and LTM2987 only.
 			- Not supported for chip temperature sensor on LTC2974
 			  and LTC2975.
 
@@ -377,13 +377,13 @@  power1_input		Measured input power.
 
 power[N]_label		"pout[1-4]".
 
-      - LTC2972: N=1-2
+			- LTC2972: N=1-2
 			- LTC2974, LTC2975: N=1-4
 			- LTC2977, LTC2979, LTC2980, LTM2987: Not supported
 			- LTC2978: Not supported
 			- LTC3880, LTC3882, LTC3884, LTC3886, LTC3887, LTC3889,
-        LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
-        LTM4700: N=1-2
+			  LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
+			  LTM4700: N=1-2
 			- LTC3883: N=2
 
 power[N]_input		Measured output power.
@@ -391,8 +391,8 @@  power[N]_input		Measured output power.
 curr1_label		"iin".
 
 			LTC3880, LTC3883, LTC3884, LTC3886, LTC3887, LTC3889,
-      LTM4644, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
-      and LTM4700 only.
+			LTM4644, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
+			and LTM4700 only.
 
 curr1_input		Measured input current.
 
@@ -410,13 +410,13 @@  curr1_reset_history	Reset input current history.
 
 curr[N]_label		"iout[1-4]".
 
-      - LTC2972: N-1-2
+			- LTC2972: N-1-2
 			- LTC2974, LTC2975: N=1-4
 			- LTC2977, LTC2979, LTC2980, LTM2987: not supported
 			- LTC2978: not supported
 			- LTC3880, LTC3882, LTC3884, LTC3886, LTC3887, LTC3889,
-        LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
-        LTM4700: N=2-3
+			  LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
+			  LTM4700: N=2-3
 			- LTC3883: N=2
 
 curr[N]_input		Measured output current.