Skip to contentSkip to conversation

docs: driver-api/thermal/intel_dptf: Include isonum.txt

PATCH In review Akira Yokosawa 3 participants 4 messages Apr 1, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: driver-api/thermal/intel_dptf: Include isonum.txt

For the "|copy|" substitution to work, need to include isonum.txt.

Fixes 16c02447f3e1 ("Documentation: thermal: DPTF Documentation")

Reported by: Randy Dunlap <[email protected]>

---
Hi,

This fixes a doc build warning reported by Randy at
https://lore.kernel.org/r/[email protected]/.

Thanks, Akira
--

 Documentation/driver-api/thermal/intel_dptf.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/driver-api/thermal/intel_dptf.rst +2 -0
index 96668dca753a..2df82719c5be 100644
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+.. include:: <isonum.txt>
+
 ===============================================================
 Intel(R) Dynamic Platform and Thermal Framework Sysfs Interface
 ===============================================================
Signature · 1 line
2.25.1
reviewer Tested-by Acked-by on v1 1/1
#1 lore raw
Quoted 9 lines · Akira Yokosawa

For the "|copy|" substitution to work, need to include isonum.txt.

Fixes 16c02447f3e1 ("Documentation: thermal: DPTF Documentation")

Reported by: Randy Dunlap <[email protected]>

Thanks.

Quoted 23 lines

---
Hi,

This fixes a doc build warning reported by Randy at
https://lore.kernel.org/r/[email protected]/.

Thanks, Akira
--

 Documentation/driver-api/thermal/intel_dptf.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/driver-api/thermal/intel_dptf.rst +2 -0
index 96668dca753a..2df82719c5be 100644
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+.. include:: <isonum.txt>
+
 ===============================================================
 Intel(R) Dynamic Platform and Thermal Framework Sysfs Interface
 ===============================================================
Signature · 1 line
~Randy
maintainer
#2 lore raw
In reply to Akira Yokosawa
Quoted 25 lines · Akira Yokosawa

For the "|copy|" substitution to work, need to include isonum.txt.

Fixes 16c02447f3e1 ("Documentation: thermal: DPTF Documentation")

Reported by: Randy Dunlap <[email protected]>

---
Hi,

This fixes a doc build warning reported by Randy at
https://lore.kernel.org/r/[email protected]/.

Thanks, Akira
--

 Documentation/driver-api/thermal/intel_dptf.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/driver-api/thermal/intel_dptf.rst +0 -0
index 96668dca753a..2df82719c5be 100644

Documentation/driver-api/thermal/intel_dptf.rst line 4

Quoted 4 lines
Documentation/driver-api/thermal/intel_dptf.rst +2 -0
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+.. include:: <isonum.txt>
+

Interesting...I don't think that was always necessary.

I have to ask, though: is this worth it? It adds up to a fair amount of clutter to get one symbol - © - that can also just be inserted directly if we really think we need it. I'd vote for doing a global s/|copy|/©/ instead.

Thanks,

jon

#3 lore raw

On Fri, 01 Apr 2022 08:41:04 -0600,
Jonathan Corbet wrote:
[...]

Quoted 5 lines

Interesting...I don't think that was always necessary.

I have to ask, though: is this worth it? It adds up to a fair amount of clutter to get one symbol - © - that can also just be inserted directly if we really think we need it.

Good point. The motto here is "Be nice to readers of .rst files". Just sent out a v2.

Quoted 2 lines

I'd vote for doing a global s/|copy|/©/
instead.

I leave those cleanups to someone who can spare one's energy and time.

Thanks, Akira

Quoted 4 lines

Thanks,

jon