Re: [PATCH] platform/x86: intel_ips: fix kernel-doc formatting

From: Ilpo Järvinen
Date: Fri Dec 08 2023 - 06:24:46 EST


On Tue, 05 Dec 2023 22:01:18 -0800, Randy Dunlap wrote:

> Fix kernel-doc function notation and comment formatting to prevent
> warnings from scripts/kernel-doc.
>
> for drivers/platform/x86/intel_ips.c:
> 595: warning: No description found for return value of 'mcp_exceeded'
> 624: warning: No description found for return value of 'cpu_exceeded'
> 650: warning: No description found for return value of 'mch_exceeded'
> 745: warning: bad line: cpu+ gpu+ cpu+gpu- cpu-gpu+ cpu-gpu-
> 746: warning: bad line: cpu < gpu < cpu+gpu+ cpu+ gpu+ nothing
> 753: warning: No description found for return value of 'ips_adjust'
> 747: warning: bad line: cpu < gpu >= cpu+gpu-(mcp<) cpu+gpu-(mcp<) gpu- gpu-
> 748: warning: bad line: cpu >= gpu < cpu-gpu+(mcp<) cpu- cpu-gpu+(mcp<) cpu-
> 749: warning: bad line: cpu >= gpu >= cpu-gpu- cpu-gpu- cpu-gpu- cpu-gpu-
> 945: warning: No description found for return value of 'ips_monitor'
> 1151: warning: No description found for return value of 'ips_irq_handler'
> 1301: warning: Function parameter or member 'ips' not described in 'ips_detect_cpu'
> 1302: warning: No description found for return value of 'ips_detect_cpu'
> 1358: warning: No description found for return value of 'ips_get_i915_syms'
>
> [...]


Thank you for your contribution, it has been applied to my local
review-ilpo branch. Note it will show up in the public
platform-drivers-x86/review-ilpo branch only once I've pushed my
local branch there, which might take a while.

The list of commits applied:
[1/1] platform/x86: intel_ips: fix kernel-doc formatting
commit: 7bcd032370f88fd4022b6926d101403e96a86309

--
i.