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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 13 Feb 2023 02:15:36 -0800
From:   srinivas pandruvada <srinivas.pandruvada@...ux.intel.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>,
        Linux Documentation <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Power Management <linux-pm@...r.kernel.org>
Cc:     Jonathan Corbet <corbet@....net>,
        "Rafael J. Wysocki" <rafael@...nel.org>,
        Daniel Lezcano <daniel.lezcano@...aro.org>,
        Amit Kucheria <amitk@...nel.org>,
        Zhang Rui <rui.zhang@...el.com>,
        Thorsten Leemhuis <linux@...mhuis.info>,
        Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
        Arjan van de Ven <arjan@...ux.intel.com>,
        Jacob Pan <jacob.jun.pan@...ux.intel.com>,
        oe-kbuild-all@...ts.linux.dev, kernel test robot <lkp@...el.com>
Subject: Re: [PATCH 1/3] Documentation: admin-guide: Add toctree entry for
 thermal docs

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@...el.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.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