diff mbox series

[1/3] Documentation: admin-guide: Add toctree entry for thermal docs

Message ID 20230213100800.28333-2-bagasdotme@gmail.com
State New
Headers
Series Documentation fixes for thermal/bleeding-edge |

Commit Message

Bagas Sanjaya Feb. 13, 2023, 10:07 a.m. UTC 
  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.

Link: https://lore.kernel.org/linux-doc/202302121759.MmJgDTxc-lkp@intel.com/
Fixes: 707bf8e1dfd51d ("Documentation: admin-guide: Move intel_powerclamp documentation")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 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

Comments

srinivas pandruvada Feb. 13, 2023, 10:15 a.m. UTC | #1 
Hi Sanjaya,

On Mon, 2023-02-13 at 17:07 +0700, Bagas Sanjaya wrote:
> 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.
> 
I submitted a patch 
	[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
warnings

Thanks,
Srinivas

> Link:
> https://lore.kernel.org/linux-doc/202302121759.MmJgDTxc-lkp@intel.com/
> Fixes: 707bf8e1dfd51d ("Documentation: admin-guide: Move
> intel_powerclamp documentation")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  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
> 
> diff --git a/Documentation/admin-guide/index.rst
> b/Documentation/admin-guide/index.rst
> index c872a8a1ddfa28..0571938ecdc868 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 00000000000000..193b7b01a87d7e
> --- /dev/null
> +++ b/Documentation/admin-guide/thermal/index.rst
> @@ -0,0 +1,8 @@
> +=================
> +Thermal Subsystem
> +=================
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   intel_powerclamp
Bagas Sanjaya Feb. 14, 2023, 2:16 a.m. UTC | #2 
On 2/13/23 17:15, srinivas pandruvada wrote:
> Hi Sanjaya,
> 
> On Mon, 2023-02-13 at 17:07 +0700, Bagas Sanjaya wrote:
>> 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.
>>
> I submitted a patch 
> 	[thermal-bleeding-edge][PATCH] thermal: intel: powerclamp: Fix
> warnings
> 
> Thanks,
> Srinivas
> 

OK, thanks!
diff mbox series

Patch

diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index c872a8a1ddfa28..0571938ecdc868 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 00000000000000..193b7b01a87d7e
--- /dev/null
+++ b/Documentation/admin-guide/thermal/index.rst
@@ -0,0 +1,8 @@ 
+=================
+Thermal Subsystem
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   intel_powerclamp