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

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: <170203467391.2381.1940561088984223400.b4-ty@linux.intel.com>
Date:   Fri, 08 Dec 2023 13:24:33 +0200
From:   Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>
To:     linux-kernel@...r.kernel.org, Randy Dunlap <rdunlap@...radead.org>
Cc:     Hans de Goede <hdegoede@...hat.com>,
        platform-driver-x86@...r.kernel.org
Subject: Re: [PATCH] platform/x86: intel_ips: fix kernel-doc formatting

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.