linux-kernel - Re: [PATCH] cpufreq: Kconfig: fix documentation links

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] [day] [month] [year] [list]

Message-ID: <CAJZ5v0jDY3Ttz0_MecqSrvUFitU0B6d2nFEOi8QZNO=8iDAg=A@mail.gmail.com>
Date:   Wed, 21 Apr 2021 19:01:52 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Alexander Monakov <amonakov@...ras.ru>
Cc:     Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Rafael Wysocki <rjw@...ysocki.net>,
        Viresh Kumar <viresh.kumar@...aro.org>,
        Linux PM <linux-pm@...r.kernel.org>
Subject: Re: [PATCH] cpufreq: Kconfig: fix documentation links

On Tue, Apr 20, 2021 at 12:03 AM Alexander Monakov <amonakov@...ras.ru> wrote:
>
> User documentation for cpufreq governors and drivers has been moved to
> admin-guide; adjust references from Kconfig entries accordingly.
>
> Remove references from undocumented cpufreq drivers, as well as the
> 'userspace' cpufreq governor, for which no additional details are
> provided in the admin-guide text.
>
> Fixes: 2a0e49279850 ("cpufreq: User/admin documentation update and consolidation")
> Signed-off-by: Alexander Monakov <amonakov@...ras.ru>
> Cc: Rafael Wysocki <rjw@...ysocki.net>
> Cc: Viresh Kumar <viresh.kumar@...aro.org>
> Cc: linux-pm@...r.kernel.org
> ---
>  drivers/cpufreq/Kconfig | 23 ++++++-----------------
>  1 file changed, 6 insertions(+), 17 deletions(-)
>
> diff --git a/drivers/cpufreq/Kconfig b/drivers/cpufreq/Kconfig
> index 85de313ddec2..c3038cdc6865 100644
> --- a/drivers/cpufreq/Kconfig
> +++ b/drivers/cpufreq/Kconfig
> @@ -13,7 +13,8 @@ config CPU_FREQ
>           clock speed, you need to either enable a dynamic cpufreq governor
>           (see below) after boot, or use a userspace tool.
>
> -         For details, take a look at <file:Documentation/cpu-freq>.
> +         For details, take a look at
> +         <file:Documentation/admin-guide/pm/cpufreq.rst>.
>
>           If in doubt, say N.
>
> @@ -140,8 +141,6 @@ config CPU_FREQ_GOV_USERSPACE
>           To compile this driver as a module, choose M here: the
>           module will be called cpufreq_userspace.
>
> -         For details, take a look at <file:Documentation/cpu-freq/>.
> -
>           If in doubt, say Y.
>
>  config CPU_FREQ_GOV_ONDEMAND
> @@ -158,7 +157,8 @@ config CPU_FREQ_GOV_ONDEMAND
>           To compile this driver as a module, choose M here: the
>           module will be called cpufreq_ondemand.
>
> -         For details, take a look at linux/Documentation/cpu-freq.
> +         For details, take a look at
> +         <file:Documentation/admin-guide/pm/cpufreq.rst>.
>
>           If in doubt, say N.
>
> @@ -182,7 +182,8 @@ config CPU_FREQ_GOV_CONSERVATIVE
>           To compile this driver as a module, choose M here: the
>           module will be called cpufreq_conservative.
>
> -         For details, take a look at linux/Documentation/cpu-freq.
> +         For details, take a look at
> +         <file:Documentation/admin-guide/pm/cpufreq.rst>.
>
>           If in doubt, say N.
>
> @@ -246,8 +247,6 @@ config IA64_ACPI_CPUFREQ
>         This driver adds a CPUFreq driver which utilizes the ACPI
>         Processor Performance States.
>
> -       For details, take a look at <file:Documentation/cpu-freq/>.
> -
>         If in doubt, say N.
>  endif
>
> @@ -271,8 +270,6 @@ config LOONGSON2_CPUFREQ
>
>           Loongson2F and it's successors support this feature.
>
> -         For details, take a look at <file:Documentation/cpu-freq/>.
> -
>           If in doubt, say N.
>
>  config LOONGSON1_CPUFREQ
> @@ -282,8 +279,6 @@ config LOONGSON1_CPUFREQ
>           This option adds a CPUFreq driver for loongson1 processors which
>           support software configurable cpu frequency.
>
> -         For details, take a look at <file:Documentation/cpu-freq/>.
> -
>           If in doubt, say N.
>  endif
>
> @@ -293,8 +288,6 @@ config SPARC_US3_CPUFREQ
>         help
>           This adds the CPUFreq driver for UltraSPARC-III processors.
>
> -         For details, take a look at <file:Documentation/cpu-freq>.
> -
>           If in doubt, say N.
>
>  config SPARC_US2E_CPUFREQ
> @@ -302,8 +295,6 @@ config SPARC_US2E_CPUFREQ
>         help
>           This adds the CPUFreq driver for UltraSPARC-IIe processors.
>
> -         For details, take a look at <file:Documentation/cpu-freq>.
> -
>           If in doubt, say N.
>  endif
>
> @@ -318,8 +309,6 @@ config SH_CPU_FREQ
>           will also generate a notice in the boot log before disabling
>           itself if the CPU in question is not capable of rate rounding.
>
> -         For details, take a look at <file:Documentation/cpu-freq>.
> -
>           If unsure, say N.
>  endif
>
> --

Applied as 5.13 material, thanks!