linux-kernel - [PATCH] cpu: Fix W=1 build kernel-doc warning

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

Message-ID: <20240825221152.71951-2-thorsten.blum@toblux.com>
Date: Mon, 26 Aug 2024 00:11:53 +0200
From: Thorsten Blum <thorsten.blum@...lux.com>
To: tglx@...utronix.de,
	peterz@...radead.org
Cc: linux-kernel@...r.kernel.org,
	Thorsten Blum <thorsten.blum@...lux.com>
Subject: [PATCH] cpu: Fix W=1 build kernel-doc warning

Building the kernel with W=1 generates the following warning:

  kernel/cpu.c:2693: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

The function topology_is_core_online() is a simple helper function and
doesn't need a kernel-doc comment.

Use a normal comment instead to remove this warning.

Signed-off-by: Thorsten Blum <thorsten.blum@...lux.com>
---
 kernel/cpu.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/cpu.c b/kernel/cpu.c
index b1fd2a3db91a..852ff634d86f 100644
--- a/kernel/cpu.c
+++ b/kernel/cpu.c
@@ -2689,7 +2689,7 @@ int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval)
 	return ret;
 }

-/**
+/*
  * Check if the core a CPU belongs to is online
  */
 #if !defined(topology_is_core_online)
-- 
2.46.0