Commit Graph

5 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab
0c12018e01 docs: thermal: convert cpu-idle-cooling.rst to ReST
Despite being named with .rst extension, this file doesn't
match the ReST standard. It actually causes a crash at
Sphinx:

	Sphinx parallel build error:
	docutils.utils.SystemMessage: /devel/v4l/docs/Documentation/driver-api/thermal/cpu-idle-cooling.rst:69: (SEVERE/4) Unexpected section title.

Add needed markups for it to be properly parsed.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/7640755514809a7b5fe2756f3702613865877dcb.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-06-19 14:03:00 -06:00
Wang Wenhu
56b6254078 doc: thermal: add cpu-idle-cooling to index tree
Add cpu-idle-cooling.rst to the index list for user reference through
self-compiled htmldocs or online documentation tree of kernel.

Like: https://www.kernel.org/doc/html/latest/driver-api/thermal/index.html

Signed-off-by: Wang Wenhu <wenhu.wang@vivo.com>
Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/20200429131109.80891-1-wenhu.wang@vivo.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-05-05 09:57:14 -06:00
Sergey Vidishev
11700fcb90 Documentation: cpu-idle-cooling: Fix diagram for 33% duty cycle
Signed-off-by: Sergey Vidishev <sergeyv@yandex-team.ru>
Signed-off-by: Daniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/2374188.AZIXMmL6Zy@sergeyv-box
2020-04-07 10:45:15 +02:00
Randy Dunlap
fe27f13d67 Documentation: cpu-idle-cooling: fix a SEVERE docs build failure
Sphinx ('make htmldocs') stops with a SEVERE error:

Sphinx parallel build error:
SystemMessage: /home/rdunlap/lnx/next/linux-next-20200120/Documentation/driver-api/thermal/cpu-idle-cooling.rst:69: (SEVERE/4) Unexpected section title.

^
|

so fix the .rst file so that the SEVERE build error does not happen.
Also fix another minor formatting warning (unexpected unindent).

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Zhang Rui <rui.zhang@intel.com>
Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
Cc: Amit Kucheria <amit.kucheria@verdurent.com>
Cc: linux-pm@vger.kernel.org
Signed-off-by: Daniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/712c1152-56b5-307f-b3f3-ed03a30b804a@infradead.org
2020-01-31 10:50:33 +01:00
Daniel Lezcano
0a1990a2d1 thermal/drivers/cpu_cooling: Add idle cooling device documentation
Provide some documentation for the idle injection cooling effect in
order to let people to understand the rational of the approach for the
idle injection CPU cooling device.

Signed-off-by: Daniel Lezcano <daniel.lezcano@linaro.org>
Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
Link: https://lore.kernel.org/r/20191219225317.17158-1-daniel.lezcano@linaro.org
2020-01-27 10:24:32 +01:00