Documentation fixes for thermal/bleeding-edge
Subsystems (2)
cover Documentation fixes for thermal/bleeding-edge
Here are documentation fixes for thermal/bleeding-edge tree. The first two patches are fixes to recently reported kernel test robot reports whereas the third patch is cosmetical (formatting).
Bagas Sanjaya (3):
Documentation: admin-guide: Add toctree entry for thermal docs
Documentation: powerclamp: Escape wildcard in cpumask description
Documentation: powerclamp: Fix numbered lists formatting
Documentation/admin-guide/index.rst | 2 +- Documentation/admin-guide/thermal/index.rst | 8 ++++++++ .../admin-guide/thermal/intel_powerclamp.rst | 15 +++++++++------ 3 files changed, 18 insertions(+), 7 deletions(-) create mode 100644 Documentation/admin-guide/thermal/index.rst
base-commit: 1c7337f9eef60b8ce8a4b8c96d197e230d60b6b2
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 1/3 Documentation: admin-guide: Add toctree entry for thermal docs
kernel test robot reported htmldocs warnings:
Documentation/admin-guide/index.rst:62: WARNING: toctree contains reference to nonexisting document 'admin-guide/thermal' Documentation/admin-guide/thermal/intel_powerclamp.rst: WARNING: document isn't included in any toctree
Add toctree entry for thermal/ docs to fix these warnings.
--- Documentation/admin-guide/index.rst | 2 +- Documentation/admin-guide/thermal/index.rst | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 Documentation/admin-guide/thermal/index.rst
Documentation/admin-guide/index.rst +1 -1
@@ -116,7 +116,7 @@ configure specific aspects of kernel behavior to your liking. svga syscall-user-dispatch sysrq - thermal + thermal/index thunderbolt ufs unicode
Documentation/admin-guide/thermal/index.rst new file +8 -0
@@ -0,0 +1,8 @@ +================= +Thermal Subsystem +================= + +.. toctree:: + :maxdepth: 1 + + intel_powerclamp
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH 1/3] Documentation: admin-guide: Add toctree entry for thermal docs
Hi Sanjaya,
Quoted 9 lines · Bagas Sanjaya
kernel test robot reported htmldocs warnings:
Documentation/admin-guide/index.rst:62: WARNING: toctree contains reference to nonexisting document 'admin-guide/thermal'Documentation/admin-guide/thermal/intel_powerclamp.rst: WARNING:
document isn't included in any toctreeAdd toctree entry for thermal/ docs to fix these warnings.
I submitted a patch
[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings
Thanks,
Srinivas
Quoted 42 lines
Link:
https://lore.kernel.org/linux-doc/[email protected]/Fixes 707bf8e1dfd51d ("Documentation: admin-guide: Move
intel_powerclampdocumentation")Reported-by kernel test robot <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>---
Documentation/admin-guide/index.rst | 2 +-Documentation/admin-guide/thermal/index.rst| 8 ++++++++2 files changed, 9 insertions(+), 1 deletion(-)create mode 100644
Documentation/admin-guide/thermal/index.rstDocumentation/admin-guide/index.rst +0
-0@@ -116,7 +116,7 @@ configure specific aspects of kernel behavior toyour liking.
svga
syscall-user-dispatch
sysrq
- thermal
+ thermal/index
thunderbolt
ufs
unicodeDocumentation/admin-guide/thermal/index.rst new file +8
-0@@ -0,0 +1,8 @@ +================= +Thermal Subsystem +================= + +.. toctree:: + :maxdepth: 1 + + intel_powerclamp
Re: [PATCH 1/3] Documentation: admin-guide: Add toctree entry for thermal docs
Quoted 10 lines · srinivas pandruvada
Hi Sanjaya,
Quoted 7 lines · Bagas Sanjaya
kernel test robot reported htmldocs warnings:
Documentation/admin-guide/index.rst:62: WARNING: toctree contains reference to nonexisting document 'admin-guide/thermal'Documentation/admin-guide/thermal/intel_powerclamp.rst: WARNING:
document isn't included in any toctree
Quoted 9 lines
Quoted 2 lines
Add toctree entry for thermal/ docs to fix these warnings.
I submitted a patch
[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warningsThanks,
Srinivas
OK, thanks!
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 2/3 Documentation: powerclamp: Escape wildcard in cpumask description
In reply to Bagas Sanjayakernel test robot reported htmldocs warning:
Documentation/admin-guide/thermal/intel_powerclamp.rst:328: WARNING: Inline emphasis start-string without end-string.
The mistaken asterisk in /proc/irq/*/smp_affinity is rendered as hyperlink as the result.
Escape the asterisk to fix above warning.
--- Documentation/admin-guide/thermal/intel_powerclamp.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/thermal/intel_powerclamp.rst +1 -1
@@ -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
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH 2/3] Documentation: powerclamp: Escape wildcard in cpumask description
Hi Sanjaya,
Quoted 9 lines · Bagas Sanjaya
kernel test robot reported htmldocs warning:
Documentation/admin-guide/thermal/intel_powerclamp.rst:328: WARNING:
Inline emphasis start-string without end-string.The mistaken asterisk in
/proc/irq/*/smp_affinityis rendered as hyperlink
as the result.
I submitted a patch
[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings.
Thanks,
Srinivas
Quoted 31 lines
Escape the asterisk to fix above warning.
Link:
https://lore.kernel.org/linux-doc/[email protected]/Fixes ebf51971021881 ("thermal: intel: powerclamp: Add two moduleparameters")
Reported-by kernel test robot <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>---
Documentation/admin-guide/thermal/intel_powerclamp.rst | 2 +-1 file changed, 1 insertion(+), 1 deletion(-)Documentation/admin-guide/thermal/intel_powerclamp.rst +0
-0@@ -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,fffffff f,ffffffff
Re: [PATCH 2/3] Documentation: powerclamp: Escape wildcard in cpumask description
Quoted 12 lines · srinivas pandruvada
Hi Sanjaya,
Quoted 9 lines · Bagas Sanjaya
kernel test robot reported htmldocs warning:
Documentation/admin-guide/thermal/intel_powerclamp.rst:328: WARNING:
Inline emphasis start-string without end-string.The mistaken asterisk in
/proc/irq/*/smp_affinityis rendered as hyperlink
as the result.
Quoted 7 lines
I submitted a patch
[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings.Thanks,
Srinivas
OK, thanks for your parallel!
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 3/3 Documentation: powerclamp: Fix numbered lists formatting
In reply to Bagas SanjayaTexts in numbered lists are rendered as continous paragraph when there should have been breaks between first line text in the beginning of list item and the description. Fix this by adding appropriate line breaks and indent the rest of lines to match the first line of numbered list item.
--- .../admin-guide/thermal/intel_powerclamp.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
Documentation/admin-guide/thermal/intel_powerclamp.rst +8 -5
@@ -155,13 +155,15 @@ b) determine the amount of compensation needed at each target ratio Compensation to each target ratio consists of two parts: a) steady state error compensation - This is to offset the error occurring when the system can - enter idle without extra wakeups (such as external interrupts). + + This is to offset the error occurring when the system can + enter idle without extra wakeups (such as external interrupts). b) dynamic error compensation - When an excessive amount of wakeups occurs during idle, an - additional idle ratio can be added to quiet interrupts, by - slowing down CPU activities. + + When an excessive amount of wakeups occurs during idle, an + additional idle ratio can be added to quiet interrupts, by + slowing down CPU activities. A debugfs file is provided for the user to examine compensation progress and results, such as on a Westmere system::
@@ -283,6 +285,7 @@ cur_state returns value -1 instead of 0 which is to avoid confusing 100% busy state with the disabled state. Example usage: + - To inject 25% idle time:: $ sudo sh -c "echo 25 > /sys/class/thermal/cooling_device80/cur_state
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 4 lines · Bagas Sanjaya
Here are documentation fixes for thermal/bleeding-edge tree. The first two patches are fixes to recently reported kernel test robot reports whereas the third patch is cosmetical (formatting).
I am fine picking up this patchset over mine, as this series has one additional fix.
[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings
Thanks,
Srinivas
Quoted 14 lines
Bagas Sanjaya (3):
Documentation: admin-guide: Add toctree entry for thermal docs
Documentation: powerclamp: Escape wildcard in cpumask description
Documentation: powerclamp: Fix numbered lists formattingDocumentation/admin-guide/index.rst | 2 +- Documentation/admin-guide/thermal/index.rst | 8 ++++++++ .../admin-guide/thermal/intel_powerclamp.rst | 15 +++++++++---- --
3 files changed, 18 insertions(+), 7 deletions(-)create mode 100644
Documentation/admin-guide/thermal/index.rstbase-commit:
1c7337f9eef60b8ce8a4b8c96d197e230d60b6b2
Rafael J. Wysocki
maintainerQuoted 11 lines · srinivas pandruvada
Quoted 4 lines · Bagas Sanjaya
Here are documentation fixes for thermal/bleeding-edge tree. The first two patches are fixes to recently reported kernel test robot reports whereas the third patch is cosmetical (formatting).
I am fine picking up this patchset over mine, as this series has one additional fix.
[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings
So applied, thanks!