All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Jean Delvare <jdelvare@suse.com>,
	Guenter Roeck <linux@roeck-us.net>,
	linux-hwmon@vger.kernel.org
Subject: [PATCH v3 09/21] docs: hwmon: coretemp: convert to ReST format
Date: Wed, 17 Apr 2019 06:46:17 -0300	[thread overview]
Message-ID: <5d264b71876d4e03dd72e27749158a30794cc1b8.1555494108.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1555494108.git.mchehab+samsung@kernel.org>

Convert coretemp to ReST format, in order to allow it to
be parsed by Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/hwmon/coretemp | 46 +++++++++++++++++++++++-------------
 1 file changed, 30 insertions(+), 16 deletions(-)

diff --git a/Documentation/hwmon/coretemp b/Documentation/hwmon/coretemp
index fec5a9bf755f..c609329e3bc4 100644
--- a/Documentation/hwmon/coretemp
+++ b/Documentation/hwmon/coretemp
@@ -3,20 +3,29 @@ Kernel driver coretemp
 
 Supported chips:
   * All Intel Core family
+
     Prefix: 'coretemp'
-    CPUID: family 0x6, models 0xe (Pentium M DC), 0xf (Core 2 DC 65nm),
-                              0x16 (Core 2 SC 65nm), 0x17 (Penryn 45nm),
-                              0x1a (Nehalem), 0x1c (Atom), 0x1e (Lynnfield),
-                              0x26 (Tunnel Creek Atom), 0x27 (Medfield Atom),
-                              0x36 (Cedar Trail Atom)
-    Datasheet: Intel 64 and IA-32 Architectures Software Developer's Manual
-               Volume 3A: System Programming Guide
-               http://softwarecommunity.intel.com/Wiki/Mobility/720.htm
+
+    CPUID: family 0x6, models
+
+			    - 0xe (Pentium M DC), 0xf (Core 2 DC 65nm),
+			    - 0x16 (Core 2 SC 65nm), 0x17 (Penryn 45nm),
+			    - 0x1a (Nehalem), 0x1c (Atom), 0x1e (Lynnfield),
+			    - 0x26 (Tunnel Creek Atom), 0x27 (Medfield Atom),
+			    - 0x36 (Cedar Trail Atom)
+
+    Datasheet:
+
+	       Intel 64 and IA-32 Architectures Software Developer's Manual
+	       Volume 3A: System Programming Guide
+
+	       http://softwarecommunity.intel.com/Wiki/Mobility/720.htm
 
 Author: Rudolf Marek
 
 Description
 -----------
+
 This driver permits reading the DTS (Digital Temperature Sensor) embedded
 inside Intel CPUs. This driver can read both the per-core and per-package
 temperature using the appropriate sensors. The per-package sensor is new;
@@ -35,14 +44,17 @@ may be raised, if the temperature grows enough (more than TjMax) to trigger
 the Out-Of-Spec bit. Following table summarizes the exported sysfs files:
 
 All Sysfs entries are named with their core_id (represented here by 'X').
-tempX_input	 - Core temperature (in millidegrees Celsius).
-tempX_max	 - All cooling devices should be turned on (on Core2).
-tempX_crit	 - Maximum junction temperature (in millidegrees Celsius).
-tempX_crit_alarm - Set when Out-of-spec bit is set, never clears.
-		   Correct CPU operation is no longer guaranteed.
-tempX_label	 - Contains string "Core X", where X is processor
-		   number. For Package temp, this will be "Physical id Y",
-		   where Y is the package number.
+
+================= ========================================================
+tempX_input	  Core temperature (in millidegrees Celsius).
+tempX_max	  All cooling devices should be turned on (on Core2).
+tempX_crit	  Maximum junction temperature (in millidegrees Celsius).
+tempX_crit_alarm  Set when Out-of-spec bit is set, never clears.
+		  Correct CPU operation is no longer guaranteed.
+tempX_label	  Contains string "Core X", where X is processor
+		  number. For Package temp, this will be "Physical id Y",
+		  where Y is the package number.
+================= ========================================================
 
 On CPU models which support it, TjMax is read from a model-specific register.
 On other models, it is set to an arbitrary value based on weak heuristics.
@@ -52,6 +64,7 @@ as a module parameter (tjmax).
 Appendix A. Known TjMax lists (TBD):
 Some information comes from ark.intel.com
 
+=============== =============================================== ================
 Process		Processor					TjMax(C)
 
 22nm		Core i5/i7 Processors
@@ -179,3 +192,4 @@ Process		Processor					TjMax(C)
 65nm		Celeron Processors
 		T1700/1600					100
 		560/550/540/530					100
+=============== =============================================== ================
-- 
2.20.1


  parent reply	other threads:[~2019-04-17  9:48 UTC|newest]

Thread overview: 150+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-10 19:22 [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
2019-04-10 19:22 ` Mauro Carvalho Chehab
2019-04-10 19:22 ` Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-11 13:05   ` Liviu Dudau
2019-04-11 13:05     ` Liviu Dudau
2019-04-10 19:22 ` [PATCH v2 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-11  0:27   ` Andrew Jeffery
2019-04-11  0:27     ` Andrew Jeffery
2019-04-10 19:22 ` [PATCH v2 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-11 13:07   ` Liviu Dudau
2019-04-11 13:07     ` Liviu Dudau
2019-04-11 13:07     ` Liviu Dudau
2019-04-11 13:07     ` Liviu Dudau
2019-04-11 18:43 ` [PATCH v2 00/21] Convert hwmon documentation to ReST Jonathan Corbet
2019-04-11 18:43   ` Jonathan Corbet
2019-04-11 18:43   ` Jonathan Corbet
2019-04-11 20:43   ` Mauro Carvalho Chehab
2019-04-11 20:43     ` Mauro Carvalho Chehab
2019-04-11 20:43     ` Mauro Carvalho Chehab
2019-04-11 21:07     ` Guenter Roeck
2019-04-11 21:07       ` Guenter Roeck
2019-04-11 21:07       ` Guenter Roeck
2019-04-11 23:54       ` Mauro Carvalho Chehab
2019-04-11 23:54         ` Mauro Carvalho Chehab
2019-04-11 23:54         ` Mauro Carvalho Chehab
2019-04-12 16:04       ` Jonathan Corbet
2019-04-12 16:04         ` Jonathan Corbet
2019-04-12 16:04         ` Jonathan Corbet
2019-04-12 16:12         ` Guenter Roeck
2019-04-12 16:12           ` Guenter Roeck
2019-04-12 16:12           ` Guenter Roeck
2019-04-13  0:25           ` Mauro Carvalho Chehab
2019-04-13  0:25             ` Mauro Carvalho Chehab
2019-04-13  0:25             ` Mauro Carvalho Chehab
2019-04-13  0:52             ` Guenter Roeck
2019-04-13  0:52               ` Guenter Roeck
2019-04-13  0:52               ` Guenter Roeck
2019-04-13  3:09         ` Guenter Roeck
2019-04-13  3:09           ` Guenter Roeck
2019-04-13  3:09           ` Guenter Roeck
2019-04-16 20:19           ` Jonathan Corbet
2019-04-16 20:19             ` Jonathan Corbet
2019-04-16 20:19             ` Jonathan Corbet
2019-04-16 20:31             ` Guenter Roeck
2019-04-16 20:31               ` Guenter Roeck
2019-04-16 20:31               ` Guenter Roeck
2019-04-17  1:58               ` Mauro Carvalho Chehab
2019-04-17  1:58                 ` Mauro Carvalho Chehab
2019-04-17  1:58                 ` Mauro Carvalho Chehab
2019-04-17  3:49                 ` Guenter Roeck
2019-04-17  3:49                   ` Guenter Roeck
2019-04-17  3:49                   ` Guenter Roeck
2019-04-17  9:46                   ` [PATCH v3 00/21]Convert " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17 10:24                       ` Liviu Dudau
2019-04-17 10:24                         ` Liviu Dudau
2019-04-17 10:31                         ` Mauro Carvalho Chehab
2019-04-17 10:31                           ` Mauro Carvalho Chehab
2019-04-17 11:29                       ` Liviu Dudau
2019-04-17 11:29                         ` Liviu Dudau
2019-04-17  9:46                     ` [PATCH v3 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` Mauro Carvalho Chehab [this message]
2019-04-17  9:46                     ` [PATCH v3 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17 11:31                       ` Liviu Dudau
2019-04-17 11:31                         ` Liviu Dudau
2019-04-17 11:31                         ` Liviu Dudau
2019-04-17 11:31                         ` Liviu Dudau
2019-04-17 16:47                       ` Guenter Roeck
2019-04-17 16:47                         ` Guenter Roeck
2019-04-17 16:47                         ` Guenter Roeck
2019-04-17 16:47                         ` Guenter Roeck
2019-04-17 16:54                         ` Guenter Roeck
2019-04-17 16:54                           ` Guenter Roeck
2019-04-17 16:54                           ` Guenter Roeck
2019-04-17 16:54                           ` Guenter Roeck
2019-04-17 17:13                         ` Mauro Carvalho Chehab
2019-04-17 17:13                           ` Mauro Carvalho Chehab
2019-04-17 17:13                           ` Mauro Carvalho Chehab
2019-04-17 17:13                           ` Mauro Carvalho Chehab
2019-04-17 17:22                           ` Mauro Carvalho Chehab
2019-04-17 17:22                             ` Mauro Carvalho Chehab
2019-04-17 17:22                             ` Mauro Carvalho Chehab
2019-04-17 17:22                             ` Mauro Carvalho Chehab
2019-04-17 17:43                             ` Guenter Roeck
2019-04-17 17:43                               ` Guenter Roeck
2019-04-17 17:43                               ` Guenter Roeck
2019-04-17 17:43                               ` Guenter Roeck
2019-04-17 17:47                               ` Guenter Roeck
2019-04-17 17:47                                 ` Guenter Roeck
2019-04-17 17:47                                 ` Guenter Roeck
2019-04-17 17:47                                 ` Guenter Roeck
2019-04-18  9:44                                 ` Mauro Carvalho Chehab
2019-04-18  9:44                                   ` Mauro Carvalho Chehab
2019-04-18  9:44                                   ` Mauro Carvalho Chehab
2019-04-18  9:44                                   ` Mauro Carvalho Chehab
2019-04-18 13:36                                   ` Guenter Roeck
2019-04-18 13:36                                     ` Guenter Roeck
2019-04-18 13:36                                     ` Guenter Roeck
2019-04-18 13:36                                     ` Guenter Roeck
2019-04-17  9:47                   ` [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
2019-04-17  9:47                     ` Mauro Carvalho Chehab
2019-04-17  9:47                     ` 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=5d264b71876d4e03dd72e27749158a30794cc1b8.1555494108.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-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=mchehab@infradead.org \
    /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.