diff mbox series

cpufreq: Kconfig: fix documentation links

Message ID 20210419215707.10290-1-amonakov@ispras.ru (mailing list archive)
State Awaiting Upstream
Delegated to: Rafael Wysocki
Headers show
Series cpufreq: Kconfig: fix documentation links | expand

Commit Message

Alexander Monakov April 19, 2021, 9:57 p.m. UTC
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@ispras.ru>
Cc: Rafael Wysocki <rjw@rjwysocki.net>
Cc: Viresh Kumar <viresh.kumar@linaro.org>
Cc: linux-pm@vger.kernel.org
---
 drivers/cpufreq/Kconfig | 23 ++++++-----------------
 1 file changed, 6 insertions(+), 17 deletions(-)

Comments

Rafael J. Wysocki April 21, 2021, 5:01 p.m. UTC | #1
On Tue, Apr 20, 2021 at 12:03 AM Alexander Monakov <amonakov@ispras.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@ispras.ru>
> Cc: Rafael Wysocki <rjw@rjwysocki.net>
> Cc: Viresh Kumar <viresh.kumar@linaro.org>
> Cc: linux-pm@vger.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!
diff mbox series

Patch

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