diff mbox series

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

Message ID e06542af-aa8b-0885-37a3-bb7bc5fafa1e@gmail.com
State New
Headers show
Series [-pm] docs: driver-api/thermal/intel_dptf: Include isonum.txt | expand

Commit Message

Akira Yokosawa April 1, 2022, 5:57 a.m. UTC
For the "|copy|" substitution to work, need to include isonum.txt.

Fixes: 16c02447f3e1 ("Documentation: thermal: DPTF Documentation")
Reported by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Cc: linux-pm@vger.kernel.org
Cc: linux-doc@vger.kernel.org

This fixes a doc build warning reported by Randy at

        Thanks, Akira
 Documentation/driver-api/thermal/intel_dptf.rst | 2 ++
 1 file changed, 2 insertions(+)


Akira Yokosawa April 1, 2022, 11:24 p.m. UTC | #1
On Fri, 01 Apr 2022 08:41:04 -0600,
Jonathan Corbet wrote:
> 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.

>                                 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

> Thanks,
> jon
diff mbox series


diff --git a/Documentation/driver-api/thermal/intel_dptf.rst b/Documentation/driver-api/thermal/intel_dptf.rst
index 96668dca753a..2df82719c5be 100644
--- a/Documentation/driver-api/thermal/intel_dptf.rst
+++ b/Documentation/driver-api/thermal/intel_dptf.rst
@@ -1,5 +1,7 @@ 
 .. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
 Intel(R) Dynamic Platform and Thermal Framework Sysfs Interface