[tip: smp/core] cpu: Fix W=1 build kernel-doc warning

[tip-bot2 for Thorsten Blum]

The following commit has been merged into the smp/core branch of tip:

Commit-ID:     8db70faeab9005cbab36e05ba94383075b5cb5db
Gitweb:        https://git.kernel.org/tip/8db70faeab9005cbab36e05ba94383075b5cb5db
Author:        Thorsten Blum <thorsten.blum@xxxxxxxxxx>
AuthorDate:    Mon, 26 Aug 2024 00:11:53 +02:00
Committer:     Thomas Gleixner <tglx@xxxxxxxxxxxxx>
CommitterDate: Wed, 04 Sep 2024 12:18:10 +02:00

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.

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

Use a normal comment instead.

Signed-off-by: Thorsten Blum <thorsten.blum@xxxxxxxxxx>
Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Link: https://lore.kernel.org/all/20240825221152.71951-2-thorsten.blum@xxxxxxxxxx

---
 kernel/cpu.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/kernel/cpu.c b/kernel/cpu.c
index c16a9b6..0c9c5df 100644
--- a/kernel/cpu.c
+++ b/kernel/cpu.c
@@ -2705,9 +2705,7 @@ int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval)
 	return ret;
 }
 
-/**
- * Check if the core a CPU belongs to is online
- */
+/* Check if the core a CPU belongs to is online */
 #if !defined(topology_is_core_online)
 static inline bool topology_is_core_online(unsigned int cpu)
 {