All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: unlisted-recipients:; (no To-header on input)
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Jean Delvare <jdelvare@suse.com>,
	Guenter Roeck <linux@roeck-us.net>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH 18/22] docs: hwmon: pxe1610: convert to ReST format and add to the index
Date: Mon, 22 Jul 2019 08:07:45 -0300	[thread overview]
Message-ID: <657bf022625e0888d3becf10c78d162eeb864608.1563792334.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1563792333.git.mchehab+samsung@kernel.org>

This document was recently introduced. Convert it to ReST
just like the other hwmon documents, adding it to the hwmon index.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/hwmon/index.rst                |  1 +
 Documentation/hwmon/{pxe1610 => pxe1610.rst} | 33 +++++++++++++++-----
 2 files changed, 26 insertions(+), 8 deletions(-)
 rename Documentation/hwmon/{pxe1610 => pxe1610.rst} (82%)

diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index ee090e51653a..4d5f5fec43a3 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -130,6 +130,7 @@ Hardware Monitoring Kernel Drivers
    pcf8591
    pmbus
    powr1220
+   pxe1610
    pwm-fan
    raspberrypi-hwmon
    sch5627
diff --git a/Documentation/hwmon/pxe1610 b/Documentation/hwmon/pxe1610.rst
similarity index 82%
rename from Documentation/hwmon/pxe1610
rename to Documentation/hwmon/pxe1610.rst
index 211cedeefb44..4f2388840d06 100644
--- a/Documentation/hwmon/pxe1610
+++ b/Documentation/hwmon/pxe1610.rst
@@ -2,19 +2,29 @@ Kernel driver pxe1610
 =====================
 
 Supported chips:
+
   * Infineon PXE1610
+
     Prefix: 'pxe1610'
+
     Addresses scanned: -
+
     Datasheet: Datasheet is not publicly available.
 
   * Infineon PXE1110
+
     Prefix: 'pxe1110'
+
     Addresses scanned: -
+
     Datasheet: Datasheet is not publicly available.
 
   * Infineon PXM1310
+
     Prefix: 'pxm1310'
+
     Addresses scanned: -
+
     Datasheet: Datasheet is not publicly available.
 
 Author: Vijay Khemka <vijaykhemka@fb.com>
@@ -25,14 +35,19 @@ Description
 
 PXE1610/PXE1110 are Multi-rail/Multiphase Digital Controllers
 and compliant to
-	-- Intel VR13 DC-DC converter specifications.
-	-- Intel SVID protocol.
+
+	- Intel VR13 DC-DC converter specifications.
+	- Intel SVID protocol.
+
 Used for Vcore power regulation for Intel VR13 based microprocessors
-	-- Servers, Workstations, and High-end desktops
+
+	- Servers, Workstations, and High-end desktops
 
 PXM1310 is a Multi-rail Controller and it is compliant to
-	-- Intel VR13 DC-DC converter specifications.
-	-- Intel SVID protocol.
+
+	- Intel VR13 DC-DC converter specifications.
+	- Intel SVID protocol.
+
 Used for DDR3/DDR4 Memory power regulation for Intel VR13 and
 IMVP8 based systems
 
@@ -44,10 +59,10 @@ This driver does not probe for PMBus devices. You will have
 to instantiate devices explicitly.
 
 Example: the following commands will load the driver for an PXE1610
-at address 0x70 on I2C bus #4:
+at address 0x70 on I2C bus #4::
 
-# modprobe pxe1610
-# echo pxe1610 0x70 > /sys/bus/i2c/devices/i2c-4/new_device
+    # modprobe pxe1610
+    # echo pxe1610 0x70 > /sys/bus/i2c/devices/i2c-4/new_device
 
 It can also be instantiated by declaring in device tree
 
@@ -55,6 +70,7 @@ It can also be instantiated by declaring in device tree
 Sysfs attributes
 ----------------
 
+======================  ====================================
 curr1_label		"iin"
 curr1_input		Measured input current
 curr1_alarm		Current high alarm
@@ -88,3 +104,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
+======================  ====================================
-- 
2.21.0


  parent reply	other threads:[~2019-07-22 11:08 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-22 11:07 [PATCH 00/22] ReST conversion of text files without .txt extension Mauro Carvalho Chehab
2019-07-22 11:07 ` [OpenRISC] " Mauro Carvalho Chehab
2019-07-22 11:07 ` Mauro Carvalho Chehab
2019-07-22 11:07 ` Mauro Carvalho Chehab
2019-07-22 11:07 ` Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 01/22] docs: convert markdown documents to ReST Mauro Carvalho Chehab
2019-07-22 11:07   ` Mauro Carvalho Chehab
2019-07-22 15:11   ` Rob Herring
2019-07-22 11:07 ` [PATCH 02/22] docs: i2c: convert to ReST and add to driver-api bookset Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 03/22] docs: w1: convert to ReST and add to the kAPI group of docs Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 04/22] docs: spi: convert to ReST and add it to the kABI bookset Mauro Carvalho Chehab
2019-07-22 12:11   ` Mark Brown
2019-07-22 13:10     ` Mauro Carvalho Chehab
2019-07-22 15:21       ` Mark Brown
2019-07-22 15:51         ` Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 05/22] docs: ipmb: place it at driver-api and convert to ReST Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 06/22] docs: packing: move it to core-api book and adjust markups Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 07/22] docs: admin-guide: add auxdisplay files to it after conversion to ReST Mauro Carvalho Chehab
2019-07-22 19:41   ` Miguel Ojeda
2019-07-22 11:07 ` [PATCH 08/22] docs: README.buddha: convert to ReST and add to m68k book Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 09/22] docs: parisc: convert to ReST and add to documentation body Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 10/22] docs: openrisc: " Mauro Carvalho Chehab
2019-07-22 11:07   ` [OpenRISC] " Mauro Carvalho Chehab
2019-07-25 21:08   ` Stafford Horne
2019-07-25 21:08     ` [OpenRISC] " Stafford Horne
2019-07-22 11:07 ` [PATCH 11/22] docs: isdn: convert to ReST and add to kAPI bookset Mauro Carvalho Chehab
2019-07-22 11:07   ` Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 12/22] docs: fs: cifs: convert to ReST and add to admin-guide book Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 13/22] docs: fs: convert docs without extension to ReST Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 14/22] docs: fs: convert porting " Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 15/22] docs: index.rst: don't use genindex for pdf output Mauro Carvalho Chehab
2019-07-22 11:07   ` Mauro Carvalho Chehab
2019-07-25 13:44   ` Vinod Koul
2019-07-22 11:07 ` [PATCH 16/22] docs: wimax: convert to ReST and add to admin-guide Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 17/22] docs: mips: add to the documentation body as ReST Mauro Carvalho Chehab
2019-07-22 17:51   ` Paul Burton
2019-07-22 11:07 ` Mauro Carvalho Chehab [this message]
2019-07-22 11:07 ` [PATCH 19/22] docs: nios2: add it to the main Documentation body Mauro Carvalho Chehab
2019-07-22 11:07 ` [PATCH 20/22] docs: net: convert two README files to ReST format Mauro Carvalho Chehab

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=657bf022625e0888d3becf10c78d162eeb864608.1563792334.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=jdelvare@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux@roeck-us.net \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.