linux-kernel - [tip: x86/cleanups] x86/platform/intel/quark: Fix incorrect kernel-doc comment syntax in files

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]

Date:   Sat, 10 Apr 2021 12:02:04 -0000
From:   "tip-bot2 for Aditya Srivastava" <tip-bot2@...utronix.de>
To:     linux-tip-commits@...r.kernel.org
Cc:     Aditya Srivastava <yashsri421@...il.com>,
        Thomas Gleixner <tglx@...utronix.de>,
        Randy Dunlap <rdunlap@...radead.org>, x86@...nel.org,
        linux-kernel@...r.kernel.org
Subject: [tip: x86/cleanups] x86/platform/intel/quark: Fix incorrect
 kernel-doc comment syntax in files

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

Commit-ID:     0d6c8e1e246586b81cb4e6ab1a93a6d4a08a0cf9
Gitweb:        https://git.kernel.org/tip/0d6c8e1e246586b81cb4e6ab1a93a6d4a08a0cf9
Author:        Aditya Srivastava <yashsri421@...il.com>
AuthorDate:    Wed, 31 Mar 2021 03:00:22 +05:30
Committer:     Thomas Gleixner <tglx@...utronix.de>
CommitterDate: Sat, 10 Apr 2021 13:59:25 +02:00

x86/platform/intel/quark: Fix incorrect kernel-doc comment syntax in files

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
There are certain files in arch/x86/platform/intel-quark, which follow this
syntax, but the content inside does not comply with kernel-doc.
Such lines were probably not meant for kernel-doc parsing, but are parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warnings from kernel-doc.

E.g., presence of kernel-doc like comment in the header lines for
arch/x86/platform/intel-quark/imr.c causes these warnings:
"warning: Function parameter or member 'fmt' not described in 'pr_fmt'"
"warning: expecting prototype for c(). Prototype was for pr_fmt() instead"

Similarly for arch/x86/platform/intel-quark/imr_selftest.c too.

Provide a simple fix by replacing these occurrences with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.

Signed-off-by: Aditya Srivastava <yashsri421@...il.com>
Signed-off-by: Thomas Gleixner <tglx@...utronix.de>
Acked-by: Randy Dunlap <rdunlap@...radead.org>
Link: https://lore.kernel.org/r/20210330213022.28769-1-yashsri421@gmail.com

---
 arch/x86/platform/intel-quark/imr.c          | 2 +-
 arch/x86/platform/intel-quark/imr_selftest.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/arch/x86/platform/intel-quark/imr.c b/arch/x86/platform/intel-quark/imr.c
index 122e0f3..d3d4569 100644
--- a/arch/x86/platform/intel-quark/imr.c
+++ b/arch/x86/platform/intel-quark/imr.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * imr.c -- Intel Isolated Memory Region driver
  *
  * Copyright(c) 2013 Intel Corporation.
diff --git a/arch/x86/platform/intel-quark/imr_selftest.c b/arch/x86/platform/intel-quark/imr_selftest.c
index 570e306..761f368 100644
--- a/arch/x86/platform/intel-quark/imr_selftest.c
+++ b/arch/x86/platform/intel-quark/imr_selftest.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * imr_selftest.c -- Intel Isolated Memory Region self-test driver
  *
  * Copyright(c) 2013 Intel Corporation.