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

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

[Akira Yokosawa]

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
---
Hi,

This fixes a doc build warning reported by Randy at
https://lore.kernel.org/r/73d98132-1d08-ef29-edb7-9e062b9154b8@infradead.org/.

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

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
 ===============================================================
-- 
2.25.1

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

[Randy Dunlap]

On 3/31/22 22:57, Akira Yokosawa wrote:
> 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

Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>


Thanks.

> ---
> Hi,
> 
> This fixes a doc build warning reported by Randy at
> https://lore.kernel.org/r/73d98132-1d08-ef29-edb7-9e062b9154b8@infradead.org/.
> 
>         Thanks, Akira
> --
>  Documentation/driver-api/thermal/intel_dptf.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> 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
>  ===============================================================

-- 
~Randy

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

[Jonathan Corbet]

Akira Yokosawa <akiyks@gmail.com> writes:

> 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
> ---
> Hi,
>
> This fixes a doc build warning reported by Randy at
> https://lore.kernel.org/r/73d98132-1d08-ef29-edb7-9e062b9154b8@infradead.org/.
>
>         Thanks, Akira
> --
>  Documentation/driver-api/thermal/intel_dptf.rst | 2 ++
>  1 file changed, 2 insertions(+)
>
> 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>
> +

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

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

[Akira Yokosawa]

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