cpufreq: intel_pstate: fix struct cpudata::epp_cached kernel-doc

[PATCH] cpufreq: intel_pstate: fix struct cpudata::epp_cached kernel-doc

Posted by Jeff Johnson 2 weeks ago

make C=1 currently gives the following warning:

drivers/cpufreq/intel_pstate.c:262: warning: Function parameter or struct member 'epp_cached' not described in 'cpudata'

Add the missing ":" to fix the trivial kernel-doc syntax error.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/cpufreq/intel_pstate.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/cpufreq/intel_pstate.c b/drivers/cpufreq/intel_pstate.c
index dbbf299f4219..7ddf05c9ba88 100644
--- a/drivers/cpufreq/intel_pstate.c
+++ b/drivers/cpufreq/intel_pstate.c
@@ -213,7 +213,7 @@ struct global_params {
  * @epp_policy:		Last saved policy used to set EPP/EPB
  * @epp_default:	Power on default HWP energy performance
  *			preference/bias
- * @epp_cached		Cached HWP energy-performance preference value
+ * @epp_cached:		Cached HWP energy-performance preference value
  * @hwp_req_cached:	Cached value of the last HWP Request MSR
  * @hwp_cap_cached:	Cached value of the last HWP Capabilities MSR
  * @last_io_update:	Last time when IO wake flag was set

---
base-commit: 2c4d8e19cf060744a9db466ffbaea13ab37f25ca
change-id: 20240505-epp_cached-kdoc-aca091e33afa

Re: [PATCH] cpufreq: intel_pstate: fix struct cpudata::epp_cached kernel-doc

Posted by Rafael J. Wysocki 1 week, 5 days ago

On Sun, May 5, 2024 at 9:07 PM Jeff Johnson <quic_jjohnson@quicinc.com> wrote:
>
> make C=1 currently gives the following warning:
>
> drivers/cpufreq/intel_pstate.c:262: warning: Function parameter or struct member 'epp_cached' not described in 'cpudata'
>
> Add the missing ":" to fix the trivial kernel-doc syntax error.
>
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
>  drivers/cpufreq/intel_pstate.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/cpufreq/intel_pstate.c b/drivers/cpufreq/intel_pstate.c
> index dbbf299f4219..7ddf05c9ba88 100644
> --- a/drivers/cpufreq/intel_pstate.c
> +++ b/drivers/cpufreq/intel_pstate.c
> @@ -213,7 +213,7 @@ struct global_params {
>   * @epp_policy:                Last saved policy used to set EPP/EPB
>   * @epp_default:       Power on default HWP energy performance
>   *                     preference/bias
> - * @epp_cached         Cached HWP energy-performance preference value
> + * @epp_cached:                Cached HWP energy-performance preference value
>   * @hwp_req_cached:    Cached value of the last HWP Request MSR
>   * @hwp_cap_cached:    Cached value of the last HWP Capabilities MSR
>   * @last_io_update:    Last time when IO wake flag was set
>
> ---

Applied as 6.10 material, thanks!