Linux-Hwmon Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] docs: hwmon: convert three docs to ReST format
@ 2019-04-22 17:39 Mauro Carvalho Chehab
  2019-04-22 22:28 ` Guenter Roeck
  0 siblings, 1 reply; 2+ messages in thread
From: Mauro Carvalho Chehab @ 2019-04-22 17:39 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Jean Delvare, Guenter Roeck, Charles Keepax,
	Richard Fitzgerald, linux-hwmon, patches

Those three new drivers were missed on the initial conversion
to ReST format. So:

- Rename them to .rst;
- Add them to the hwmon index.rst index;
- add some blank lines at the "Supported systems:" part, in
  order to allow Sphinx to properly identify new lines,
  suppressing warnings and avoid it to output some random
  lines in bold;
- When multiple authors are involved, change the authors
  part to a list, in order to avoid adding blank lines.
- adjust the table cells (one of the tables seemed to be
  assuming that tab is 4 positions instead of 8) and add
  the table markup.
- be sure that the section markups have the same number of
  characters as the section title.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/hwmon/index.rst                 |  3 +++
 Documentation/hwmon/{ir38064 => ir38064.rst}  | 21 ++++++++++++-------
 .../hwmon/{isl68137 => isl68137.rst}          | 16 ++++++++++----
 .../hwmon/{lochnagar => lochnagar.rst}        |  7 +++++--
 4 files changed, 33 insertions(+), 14 deletions(-)
 rename Documentation/hwmon/{ir38064 => ir38064.rst} (76%)
 rename Documentation/hwmon/{isl68137 => isl68137.rst} (85%)
 rename Documentation/hwmon/{lochnagar => lochnagar.rst} (93%)

diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 893804414510..3fa14fe7b49c 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -65,6 +65,8 @@ Hardware Monitoring Kernel Drivers
    ina2xx.rst
    ina3221.rst
    ir35221.rst
+   ir38064.rst
+   isl68137.rst
    it87.rst
    jc42.rst
    k10temp.rst
@@ -86,6 +88,7 @@ Hardware Monitoring Kernel Drivers
    lm93.rst
    lm95234.rst
    lm95245.rst
+   lochnagar.rst
    ltc2945.rst
    ltc2978.rst
    ltc2990.rst
diff --git a/Documentation/hwmon/ir38064 b/Documentation/hwmon/ir38064.rst
similarity index 76%
rename from Documentation/hwmon/ir38064
rename to Documentation/hwmon/ir38064.rst
index 9f218c39bfe6..c455d755a267 100644
--- a/Documentation/hwmon/ir38064
+++ b/Documentation/hwmon/ir38064.rst
@@ -2,15 +2,18 @@ Kernel driver ir38064
 =====================
 
 Supported chips:
+
   * Infineon IR38064
+
     Prefix: 'ir38064'
     Addresses scanned: -
+
     Datasheet: Publicly available at the Infineon webiste
       https://www.infineon.com/dgdl/Infineon-IR38064MTRPBF-DS-v03_07-EN.pdf?fileId=5546d462584d1d4a0158db0d9efb67ca
 
 Authors:
-        Maxim Sloyko <maxims@google.com>
-        Patrick Venture <venture@google.com>
+      - Maxim Sloyko <maxims@google.com>
+      - Patrick Venture <venture@google.com>
 
 Description
 -----------
@@ -26,29 +29,30 @@ devices explicitly.
 Sysfs attributes
 ----------------
 
+======================= ===========================
 curr1_label		"iout1"
 curr1_input		Measured output current
 curr1_crit		Critical maximum current
 curr1_crit_alarm	Current critical high alarm
 curr1_max		Maximum current
-curr1_max_alarm	Current high alarm
+curr1_max_alarm		Current high alarm
 
 in1_label		"vin"
 in1_input		Measured input voltage
 in1_crit		Critical maximum input voltage
 in1_crit_alarm		Input voltage critical high alarm
-in1_min		Minimum input voltage
+in1_min			Minimum input voltage
 in1_min_alarm		Input voltage low alarm
 
 in2_label		"vout1"
 in2_input		Measured output voltage
 in2_lcrit		Critical minimum output voltage
-in2_lcrit_alarm	Output voltage critical low alarm
+in2_lcrit_alarm		Output voltage critical low alarm
 in2_crit		Critical maximum output voltage
 in2_crit_alarm		Output voltage critical high alarm
-in2_max		Maximum output voltage
+in2_max			Maximum output voltage
 in2_max_alarm		Output voltage high alarm
-in2_min		Minimum output voltage
+in2_min			Minimum output voltage
 in2_min_alarm		Output voltage low alarm
 
 power1_label		"pout1"
@@ -58,4 +62,5 @@ temp1_input		Measured temperature
 temp1_crit		Critical high temperature
 temp1_crit_alarm	Chip temperature critical high alarm
 temp1_max		Maximum temperature
-temp1_max_alarm	Chip temperature high alarm
+temp1_max_alarm		Chip temperature high alarm
+======================= ===========================
diff --git a/Documentation/hwmon/isl68137 b/Documentation/hwmon/isl68137.rst
similarity index 85%
rename from Documentation/hwmon/isl68137
rename to Documentation/hwmon/isl68137.rst
index 92e5c5fc5b77..a5a7c8545c9e 100644
--- a/Documentation/hwmon/isl68137
+++ b/Documentation/hwmon/isl68137.rst
@@ -2,16 +2,22 @@ Kernel driver isl68137
 ======================
 
 Supported chips:
+
   * Intersil ISL68137
+
     Prefix: 'isl68137'
+
     Addresses scanned: -
-    Datasheet: Publicly available at the Intersil website
+
+    Datasheet:
+
+      Publicly available at the Intersil website
       https://www.intersil.com/content/dam/Intersil/documents/isl6/isl68137.pdf
 
 Authors:
-        Maxim Sloyko <maxims@google.com>
-        Robert Lippert <rlippert@google.com>
-        Patrick Venture <venture@google.com>
+      - Maxim Sloyko <maxims@google.com>
+      - Robert Lippert <rlippert@google.com>
+      - Patrick Venture <venture@google.com>
 
 Description
 -----------
@@ -32,6 +38,7 @@ Beyond the normal sysfs pmbus attributes, the driver exposes a control attribute
 Additional Sysfs attributes
 ---------------------------
 
+======================= ====================================
 avs(0|1)_enable		Controls the AVS state of each rail.
 
 curr1_label		"iin"
@@ -70,3 +77,4 @@ temp[1-3]_crit		Critical high temperature
 temp[1-3]_crit_alarm	Chip temperature critical high alarm
 temp[1-3]_max		Maximum temperature
 temp[1-3]_max_alarm	Chip temperature high alarm
+======================= ====================================
diff --git a/Documentation/hwmon/lochnagar b/Documentation/hwmon/lochnagar.rst
similarity index 93%
rename from Documentation/hwmon/lochnagar
rename to Documentation/hwmon/lochnagar.rst
index e9686fb3eb40..1d609c4d18c3 100644
--- a/Documentation/hwmon/lochnagar
+++ b/Documentation/hwmon/lochnagar.rst
@@ -1,5 +1,5 @@
 Kernel Driver Lochnagar
-========================
+=======================
 
 Supported systems:
   * Cirrus Logic : Lochnagar 2
@@ -21,6 +21,7 @@ by software.
 Sysfs attributes
 ----------------
 
+======================= =======================================================
 temp1_input             The Lochnagar board temperature (milliCelsius)
 in0_input               Measured voltage for DBVDD1 (milliVolts)
 in0_label               "DBVDD1"
@@ -76,5 +77,7 @@ curr8_label             "MICVDD"
 power8_average          Measured average power for MICVDD (microWatts)
 power8_average_interval Power averaging time input valid from 1 to 1708mS
 power8_label            "MICVDD"
+======================= =======================================================
 
-Note: It is not possible to measure voltage on the SYSVDD rail.
+Note:
+    It is not possible to measure voltage on the SYSVDD rail.
-- 
2.20.1


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] docs: hwmon: convert three docs to ReST format
  2019-04-22 17:39 [PATCH] docs: hwmon: convert three docs to ReST format Mauro Carvalho Chehab
@ 2019-04-22 22:28 ` Guenter Roeck
  0 siblings, 0 replies; 2+ messages in thread
From: Guenter Roeck @ 2019-04-22 22:28 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Jean Delvare, Charles Keepax,
	Richard Fitzgerald, linux-hwmon, patches

On Mon, Apr 22, 2019 at 02:39:37PM -0300, Mauro Carvalho Chehab wrote:
> Those three new drivers were missed on the initial conversion
> to ReST format. So:
> 
> - Rename them to .rst;
> - Add them to the hwmon index.rst index;
> - add some blank lines at the "Supported systems:" part, in
>   order to allow Sphinx to properly identify new lines,
>   suppressing warnings and avoid it to output some random
>   lines in bold;
> - When multiple authors are involved, change the authors
>   part to a list, in order to avoid adding blank lines.
> - adjust the table cells (one of the tables seemed to be
>   assuming that tab is 4 positions instead of 8) and add
>   the table markup.
> - be sure that the section markups have the same number of
>   characters as the section title.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Applied to hwmon-next.

Thanks,
Guenter

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-04-22 17:39 [PATCH] docs: hwmon: convert three docs to ReST format Mauro Carvalho Chehab
2019-04-22 22:28 ` Guenter Roeck

Linux-Hwmon Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-hwmon/0 linux-hwmon/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-hwmon linux-hwmon/ https://lore.kernel.org/linux-hwmon \
		linux-hwmon@vger.kernel.org linux-hwmon@archiver.kernel.org
	public-inbox-index linux-hwmon


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-hwmon


AGPL code for this site: git clone https://public-inbox.org/ public-inbox