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>,
Amit Daniel Kachhap <amit.kachhap@gmail.com>,
Viresh Kumar <viresh.kumar@linaro.org>,
Javi Merino <javi.merino@kernel.org>,
Kukjin Kim <kgene@kernel.org>,
Krzysztof Kozlowski <krzk@kernel.org>,
Zhang Rui <rui.zhang@intel.com>,
Eduardo Valentin <edubezval@gmail.com>,
Daniel Lezcano <daniel.lezcano@linaro.org>,
linux-pm@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-samsung-soc@vger.kernel.org
Subject: [PATCH 01/39] docs: thermal: add it to the driver API
Date: Fri, 28 Jun 2019 09:29:54 -0300 [thread overview]
Message-ID: <c9c7d7e0567aed7e36c4eb9c09ddfb6274913e9c.1561724493.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The file contents mostly describes driver internals.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
.../{ => driver-api}/thermal/cpu-cooling-api.rst | 0
.../{ => driver-api}/thermal/exynos_thermal.rst | 0
.../thermal/exynos_thermal_emulation.rst | 0
Documentation/{ => driver-api}/thermal/index.rst | 2 --
.../{ => driver-api}/thermal/intel_powerclamp.rst | 0
.../{ => driver-api}/thermal/nouveau_thermal.rst | 0
.../{ => driver-api}/thermal/power_allocator.rst | 0
Documentation/{ => driver-api}/thermal/sysfs-api.rst | 12 ++++++------
.../thermal/x86_pkg_temperature_thermal.rst | 2 +-
MAINTAINERS | 2 +-
include/linux/thermal.h | 4 ++--
12 files changed, 11 insertions(+), 12 deletions(-)
rename Documentation/{ => driver-api}/thermal/cpu-cooling-api.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal_emulation.rst (100%)
rename Documentation/{ => driver-api}/thermal/index.rst (95%)
rename Documentation/{ => driver-api}/thermal/intel_powerclamp.rst (100%)
rename Documentation/{ => driver-api}/thermal/nouveau_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/power_allocator.rst (100%)
rename Documentation/{ => driver-api}/thermal/sysfs-api.rst (98%)
rename Documentation/{ => driver-api}/thermal/x86_pkg_temperature_thermal.rst (94%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 0dbaa987aa11..4e503e360860 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -56,6 +56,7 @@ available subsections can be seen below.
dmaengine/index
slimbus
soundwire/index
+ thermal/index
fpga/index
acpi/index
generic-counter
diff --git a/Documentation/thermal/cpu-cooling-api.rst b/Documentation/driver-api/thermal/cpu-cooling-api.rst
similarity index 100%
rename from Documentation/thermal/cpu-cooling-api.rst
rename to Documentation/driver-api/thermal/cpu-cooling-api.rst
diff --git a/Documentation/thermal/exynos_thermal.rst b/Documentation/driver-api/thermal/exynos_thermal.rst
similarity index 100%
rename from Documentation/thermal/exynos_thermal.rst
rename to Documentation/driver-api/thermal/exynos_thermal.rst
diff --git a/Documentation/thermal/exynos_thermal_emulation.rst b/Documentation/driver-api/thermal/exynos_thermal_emulation.rst
similarity index 100%
rename from Documentation/thermal/exynos_thermal_emulation.rst
rename to Documentation/driver-api/thermal/exynos_thermal_emulation.rst
diff --git a/Documentation/thermal/index.rst b/Documentation/driver-api/thermal/index.rst
similarity index 95%
rename from Documentation/thermal/index.rst
rename to Documentation/driver-api/thermal/index.rst
index 8c1c00146cad..68ceb6886561 100644
--- a/Documentation/thermal/index.rst
+++ b/Documentation/driver-api/thermal/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
=======
Thermal
=======
diff --git a/Documentation/thermal/intel_powerclamp.rst b/Documentation/driver-api/thermal/intel_powerclamp.rst
similarity index 100%
rename from Documentation/thermal/intel_powerclamp.rst
rename to Documentation/driver-api/thermal/intel_powerclamp.rst
diff --git a/Documentation/thermal/nouveau_thermal.rst b/Documentation/driver-api/thermal/nouveau_thermal.rst
similarity index 100%
rename from Documentation/thermal/nouveau_thermal.rst
rename to Documentation/driver-api/thermal/nouveau_thermal.rst
diff --git a/Documentation/thermal/power_allocator.rst b/Documentation/driver-api/thermal/power_allocator.rst
similarity index 100%
rename from Documentation/thermal/power_allocator.rst
rename to Documentation/driver-api/thermal/power_allocator.rst
diff --git a/Documentation/thermal/sysfs-api.rst b/Documentation/driver-api/thermal/sysfs-api.rst
similarity index 98%
rename from Documentation/thermal/sysfs-api.rst
rename to Documentation/driver-api/thermal/sysfs-api.rst
index e4930761d3e5..fab2c9b36d08 100644
--- a/Documentation/thermal/sysfs-api.rst
+++ b/Documentation/driver-api/thermal/sysfs-api.rst
@@ -552,7 +552,7 @@ emul_temp
sustainable_power
An estimate of the sustained power that can be dissipated by
the thermal zone. Used by the power allocator governor. For
- more information see Documentation/thermal/power_allocator.rst
+ more information see Documentation/driver-api/thermal/power_allocator.rst
Unit: milliwatts
@@ -563,7 +563,7 @@ k_po
controller during temperature overshoot. Temperature overshoot
is when the current temperature is above the "desired
temperature" trip point. For more information see
- Documentation/thermal/power_allocator.rst
+ Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
@@ -572,7 +572,7 @@ k_pu
controller during temperature undershoot. Temperature undershoot
is when the current temperature is below the "desired
temperature" trip point. For more information see
- Documentation/thermal/power_allocator.rst
+ Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
@@ -580,14 +580,14 @@ k_i
The integral term of the power allocator governor's PID
controller. This term allows the PID controller to compensate
for long term drift. For more information see
- Documentation/thermal/power_allocator.rst
+ Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
k_d
The derivative term of the power allocator governor's PID
controller. For more information see
- Documentation/thermal/power_allocator.rst
+ Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
@@ -598,7 +598,7 @@ integral_cutoff
example, if integral_cutoff is 0, then the integral term only
accumulates error when temperature is above the desired
temperature trip point. For more information see
- Documentation/thermal/power_allocator.rst
+ Documentation/driver-api/thermal/power_allocator.rst
Unit: millidegree Celsius
diff --git a/Documentation/thermal/x86_pkg_temperature_thermal.rst b/Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst
similarity index 94%
rename from Documentation/thermal/x86_pkg_temperature_thermal.rst
rename to Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst
index f134dbd3f5a9..2ac42ccd236f 100644
--- a/Documentation/thermal/x86_pkg_temperature_thermal.rst
+++ b/Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst
@@ -40,7 +40,7 @@ This contains two trip points:
- trip_point_1_temp
User can set any temperature between 0 to TJ-Max temperature. Temperature units
-are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for
+are in milli-degree Celsius. Refer to "Documentation/driver-api/thermal/sysfs-api.rst" for
thermal sys-fs details.
Any value other than 0 in these trip points, can trigger thermal notifications.
diff --git a/MAINTAINERS b/MAINTAINERS
index 7ba6d174f49f..9d3a408f5ce1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -15762,7 +15762,7 @@ M: Viresh Kumar <viresh.kumar@linaro.org>
M: Javi Merino <javi.merino@kernel.org>
L: linux-pm@vger.kernel.org
S: Supported
-F: Documentation/thermal/cpu-cooling-api.rst
+F: Documentation/driver-api/thermal/cpu-cooling-api.rst
F: drivers/thermal/cpu_cooling.c
F: include/linux/cpu_cooling.h
diff --git a/include/linux/thermal.h b/include/linux/thermal.h
index 681047f8cc05..e45659c75920 100644
--- a/include/linux/thermal.h
+++ b/include/linux/thermal.h
@@ -251,7 +251,7 @@ struct thermal_bind_params {
* platform characterization. This value is relative to the
* rest of the weights so a cooling device whose weight is
* double that of another cooling device is twice as
- * effective. See Documentation/thermal/sysfs-api.rst for more
+ * effective. See Documentation/driver-api/thermal/sysfs-api.rst for more
* information.
*/
int weight;
@@ -259,7 +259,7 @@ struct thermal_bind_params {
/*
* This is a bit mask that gives the binding relation between this
* thermal zone and cdev, for a particular trip point.
- * See Documentation/thermal/sysfs-api.rst for more information.
+ * See Documentation/driver-api/thermal/sysfs-api.rst for more information.
*/
int trip_mask;
--
2.21.0
next prev parent reply other threads:[~2019-06-28 12:31 UTC|newest]
Thread overview: 56+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-28 12:29 [PATCH 00/39] Don't let ReST documents orphaned Mauro Carvalho Chehab
2019-06-28 12:29 ` Mauro Carvalho Chehab [this message]
2019-06-28 12:29 ` [PATCH 02/39] docs: rapidio: add it to the driver API Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 03/39] docs: perf: move to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 04/39] docs: nvdimm: add it to the driver-api book Mauro Carvalho Chehab
2019-06-28 16:33 ` Dan Williams
2019-06-28 12:29 ` [PATCH 05/39] docs: namespace: move it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 06/39] docs: mtd: move it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 07/39] docs: nfc: add " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 08/39] docs: mmc: move it to the driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 09/39] docs: md: move it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 10/39] docs: leds: add " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 11/39] docs: ioctl: add it to the uAPI guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 12/39] docs: interconnect.rst: add it to the driver-api guide Mauro Carvalho Chehab
2019-06-28 13:55 ` Georgi Djakov
2019-06-28 12:30 ` [PATCH 13/39] docs: add arch doc directories to the index Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 14/39] docs: device-mapper: move it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 15/39] docs: early-userspace: move to driver-api guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 16/39] docs: admin-guide: move sysctl directory to it Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 17/39] docs: admin-guide: add laptops documentation Mauro Carvalho Chehab
2019-06-28 14:51 ` Andy Shevchenko
2019-06-28 12:30 ` [PATCH 18/39] docs: admin-guide: add kdump documentation into it Mauro Carvalho Chehab
2019-07-05 3:43 ` Alex Shi
2019-07-05 5:59 ` Dave Young
2019-07-06 11:46 ` Mauro Carvalho Chehab
2019-07-05 5:55 ` Dave Young
2019-06-28 12:30 ` [PATCH 19/39] docs: blockdev: add it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 20/39] docs: security: move some books to it and update Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 21/39] docs: x86: move two x86-specific files to x86 arch dir Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 22/39] docs: ocxl.rst: add it to the uAPI book Mauro Carvalho Chehab
2019-07-01 1:21 ` Andrew Donnellan
2019-06-28 12:30 ` [PATCH 23/39] docs: lp855x-driver.rst: add it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 24/39] docs: driver-model: move " Mauro Carvalho Chehab
2019-06-28 18:53 ` Jeff Kirsher
2019-06-28 12:30 ` [PATCH 25/39] docs: add some documentation dirs " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 26/39] docs: aoe: add it " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 27/39] docs: cgroup-v1: add it to the admin-guide book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Mauro Carvalho Chehab
2019-06-28 12:43 ` Alexandre Belloni
2019-06-28 12:54 ` Bartlomiej Zolnierkiewicz
2019-06-28 12:30 ` [PATCH 30/39] docs: driver-api: add xilinx driver API documentation Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 31/39] docs: driver-api: add remaining converted dirs to it Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 32/39] docs: serial: move it to the driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 33/39] docs: phy: place documentation under driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 34/39] docs: add a memory-devices subdir to driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 35/39] docs: infiniband: add it to the driver-api bookset Mauro Carvalho Chehab
2019-07-03 18:08 ` Jason Gunthorpe
2019-07-06 11:19 ` Mauro Carvalho Chehab
2019-07-08 17:25 ` Jason Gunthorpe
2019-06-28 12:30 ` [PATCH 36/39] docs: add SPDX tags to new index files Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 37/39] docs: adds some directories to the main documentation index Mauro Carvalho Chehab
2019-06-28 12:55 ` Bartlomiej Zolnierkiewicz
2019-06-28 12:30 ` [PATCH 38/39] docs: locking: add it to the main index Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 39/39] docs: gpio: add sysfs interface to the admin-guide Mauro Carvalho Chehab
2019-07-03 8:44 ` Linus Walleij
2019-07-06 11:43 ` 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=c9c7d7e0567aed7e36c4eb9c09ddfb6274913e9c.1561724493.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=amit.kachhap@gmail.com \
--cc=corbet@lwn.net \
--cc=daniel.lezcano@linaro.org \
--cc=edubezval@gmail.com \
--cc=javi.merino@kernel.org \
--cc=kgene@kernel.org \
--cc=krzk@kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux-samsung-soc@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=rui.zhang@intel.com \
--cc=viresh.kumar@linaro.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).