linux-kernel - [tip: x86/cleanups] x86/sgx: Fix a W=1 build warning in function comment

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

Message-ID: <172458943182.2215.2311081873541283986.tip-bot2@tip-bot2>
Date: Sun, 25 Aug 2024 12:37:11 -0000
From: "tip-bot2 for Kai Huang" <tip-bot2@...utronix.de>
To: linux-tip-commits@...r.kernel.org
Cc: Kai Huang <kai.huang@...el.com>, Thomas Gleixner <tglx@...utronix.de>,
 x86@...nel.org, linux-kernel@...r.kernel.org
Subject:
 [tip: x86/cleanups] x86/sgx: Fix a W=1 build warning in function comment

The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID:     c6e6a3c1698a86bacf7eac256b0f1215a3616dc7
Gitweb:        https://git.kernel.org/tip/c6e6a3c1698a86bacf7eac256b0f1215a3616dc7
Author:        Kai Huang <kai.huang@...el.com>
AuthorDate:    Sun, 25 Aug 2024 20:06:49 +12:00
Committer:     Thomas Gleixner <tglx@...utronix.de>
CommitterDate: Sun, 25 Aug 2024 14:29:38 +02:00

x86/sgx: Fix a W=1 build warning in function comment

Building the SGX code with W=1 generates below warning:

  arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or
  struct member 'low' not described in 'sgx_calc_section_metric'
  arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or
  struct member 'high' not described in 'sgx_calc_section_metric'
  ...

The function sgx_calc_section_metric() is a simple helper which is only
used in sgx/main.c.  There's no need to use kernel-doc style comment for
it.

Downgrade to a normal comment.

Signed-off-by: Kai Huang <kai.huang@...el.com>
Signed-off-by: Thomas Gleixner <tglx@...utronix.de>
Link: https://lore.kernel.org/all/20240825080649.145250-1-kai.huang@intel.com

---
 arch/x86/kernel/cpu/sgx/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/kernel/cpu/sgx/main.c b/arch/x86/kernel/cpu/sgx/main.c
index 27892e5..1a000ac 100644
--- a/arch/x86/kernel/cpu/sgx/main.c
+++ b/arch/x86/kernel/cpu/sgx/main.c
@@ -732,7 +732,7 @@ out:
 	return 0;
 }
 
-/**
+/*
  * A section metric is concatenated in a way that @low bits 12-31 define the
  * bits 12-31 of the metric and @high bits 0-19 define the bits 32-51 of the
  * metric.