[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix warnings
From: Srinivas Pandruvada
Date: Mon Feb 13 2023 - 00:25:33 EST
Two warnings are reported during make htmldocs:
1.Documentation/admin-guide/index.rst:62: WARNING: toctree contains
reference to nonexisting document 'admin-guide/thermal'
2.Documentation/admin-guide/thermal/intel_powerclamp.rst:328:
WARNING: Inline emphasis start-string without end-string
Fix the first warning by adding index.rst in thermal folder and
for the second issue use \ for *.
Reported-by: kernel test robot <lkp@xxxxxxxxx>
Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@xxxxxxxxxxxxxxx>
---
Documentation/admin-guide/index.rst | 2 +-
Documentation/admin-guide/thermal/index.rst | 10 ++++++++++
Documentation/admin-guide/thermal/intel_powerclamp.rst | 2 +-
3 files changed, 12 insertions(+), 2 deletions(-)
create mode 100644 Documentation/admin-guide/thermal/index.rst
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index c872a8a1ddfa..0571938ecdc8 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -116,7 +116,7 @@ configure specific aspects of kernel behavior to your liking.
svga
syscall-user-dispatch
sysrq
- thermal
+ thermal/index
thunderbolt
ufs
unicode
diff --git a/Documentation/admin-guide/thermal/index.rst b/Documentation/admin-guide/thermal/index.rst
new file mode 100644
index 000000000000..6eb3f4da40e6
--- /dev/null
+++ b/Documentation/admin-guide/thermal/index.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==================
+Thermal Management
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ intel_powerclamp
diff --git a/Documentation/admin-guide/thermal/intel_powerclamp.rst b/Documentation/admin-guide/thermal/intel_powerclamp.rst
index 2d9d2d739f02..f919fbe1cdd9 100644
--- a/Documentation/admin-guide/thermal/intel_powerclamp.rst
+++ b/Documentation/admin-guide/thermal/intel_powerclamp.rst
@@ -326,7 +326,7 @@ Module Parameters
``cpumask`` (RW)
A bit mask of CPUs to inject idle. The format of the bitmask is same as
- used in other subsystems like in /proc/irq/*/smp_affinity. The mask is
+ used in other subsystems like in /proc/irq/\*/smp_affinity. The mask is
comma separated 32 bit groups. Each CPU is one bit. For example for a 256
CPU system the full mask is:
ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff
--
2.39.1