linux-kernel - [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments

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]

Date:   Mon,  4 Apr 2022 14:02:06 +0100
From:   Sudeep Holla <sudeep.holla@....com>
To:     linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org
Cc:     Sudeep Holla <sudeep.holla@....com>,
        Liviu Dudau <liviu.dudau@....com>,
        Lorenzo Pieralisi <lorenzo.pieralisi@....com>,
        kernel test robot <lkp@...el.com>
Subject: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments

Kbuild bot reported the following doxygen build warning:

  |  arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
  |		'/**', but isn't a kernel-doc comment.
  |		Refer Documentation/doc-guide/kernel-doc.rst
  |  		* ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)

Fix the issue by dropping the parameters specified in the kernel doc.

Cc: Liviu Dudau <liviu.dudau@....com>
Cc: Lorenzo Pieralisi <lorenzo.pieralisi@....com>
Reported-by: kernel test robot <lkp@...el.com>
Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
Signed-off-by: Sudeep Holla <sudeep.holla@....com>
---
 arch/arm/mach-vexpress/spc.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
index 1c6500c4e6a1..8f99d47d4b89 100644
--- a/arch/arm/mach-vexpress/spc.c
+++ b/arch/arm/mach-vexpress/spc.c
@@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
 }
 
 /**
- * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
+ * ve_spc_cpu_in_wfi()
  *
  * @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
  * @cluster: mpidr[15:8] bitfield describing cluster affinity level
-- 
2.35.1