From patchwork Mon Apr 22 17:39:37 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 10911305 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id D422D14DB for ; Mon, 22 Apr 2019 17:39:45 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C3F0828329 for ; Mon, 22 Apr 2019 17:39:45 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B4745285D6; Mon, 22 Apr 2019 17:39:45 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.7 required=2.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id F251328329 for ; Mon, 22 Apr 2019 17:39:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727568AbfDVRjo (ORCPT ); Mon, 22 Apr 2019 13:39:44 -0400 Received: from bombadil.infradead.org ([198.137.202.133]:57600 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726260AbfDVRjo (ORCPT ); Mon, 22 Apr 2019 13:39:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Sender:Content-Transfer-Encoding: MIME-Version:Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-Type: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=yhlRNyjUqRk9rCHrDlI8HQIYmKPBj5M2+grg1BxW/8Y=; b=CCzflAM/nhpC9UfabD8W6x0ER s0/YNBbWONVnWRC3ofcVEj3tdKMMrJK0rdjzaqxVjMhEyOGrWkgXHQ9bmli327f6wz0ztbQBdFZsw qHS8Cb++3GbMku3PHUhSUywtGQT/b8JltqNRl+fOtxP6/Xq22sK0A5VlD7gR3wD2DQAU3xnWE7GR/ plMBlOrHMj4d0QHmRfKZL2jyCSfdpabAdzdfRRRyeC2UXWOvgdERkgCH+uu8p8hNgY5xA6FAEeWsC lArqvktYm3ZAu9otHP4u1cKQY7VnATm+acwJshs8H2mwNYTagU6XH+aR0kd4LpQyrZQF5FysoTL9L B8uNfIOZg==; Received: from 179.176.125.229.dynamic.adsl.gvt.net.br ([179.176.125.229] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hIcut-0001Db-4e; Mon, 22 Apr 2019 17:39:43 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hIcup-00072Y-Uy; Mon, 22 Apr 2019 14:39:39 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Jean Delvare , Guenter Roeck , Charles Keepax , Richard Fitzgerald , linux-hwmon@vger.kernel.org, patches@opensource.cirrus.com Subject: [PATCH] docs: hwmon: convert three docs to ReST format Date: Mon, 22 Apr 2019 14:39:37 -0300 Message-Id: <287cf72fc213656c1593f8bd42feb62f7a5f26e7.1555954774.git.mchehab+samsung@kernel.org> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Sender: linux-hwmon-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-hwmon@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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 --- 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 - Patrick Venture + - Maxim Sloyko + - Patrick Venture 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 - Robert Lippert - Patrick Venture + - Maxim Sloyko + - Robert Lippert + - Patrick Venture 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.