From: Aditya Srivastava <yashsri421@gmail.com>
To: courmisch@gmail.com
Cc: yashsri421@gmail.com, lukas.bulwahn@gmail.com,
rdunlap@infradead.org,
linux-kernel-mentees@lists.linuxfoundation.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2] Phonet: fix kernel-doc syntax in file headers and remove file names
Date: Sat, 22 May 2021 17:04:08 +0530 [thread overview]
Message-ID: <20210522113408.8766-1-yashsri421@gmail.com> (raw)
In-Reply-To: <52313028.m8L9TnScQ9@philogene>
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
For e.g., the header for include/linux/phonet.h follows this syntax, but
the content inside does not comply with kernel-doc.
This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warning from kernel-doc:
warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* file phonet.h
Provide a simple fix by replacing this occurrence with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Also remove the redundant file name from the comment headers.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
Changes in v2:
- Remove file name information from comment headers as well, as suggested by Randy and Remi
include/linux/phonet.h | 4 +---
include/uapi/linux/phonet.h | 4 +---
2 files changed, 2 insertions(+), 6 deletions(-)
diff --git a/include/linux/phonet.h b/include/linux/phonet.h
index bc7d1e529efc..6117a0e462d3 100644
--- a/include/linux/phonet.h
+++ b/include/linux/phonet.h
@@ -1,7 +1,5 @@
/* SPDX-License-Identifier: GPL-2.0-only */
-/**
- * file phonet.h
- *
+/*
* Phonet sockets kernel interface
*
* Copyright (C) 2008 Nokia Corporation. All rights reserved.
diff --git a/include/uapi/linux/phonet.h b/include/uapi/linux/phonet.h
index a2f6b37a5937..e7e14b5e59c6 100644
--- a/include/uapi/linux/phonet.h
+++ b/include/uapi/linux/phonet.h
@@ -1,7 +1,5 @@
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
-/**
- * file phonet.h
- *
+/*
* Phonet sockets kernel interface
*
* Copyright (C) 2008 Nokia Corporation. All rights reserved.
--
2.17.1
next prev parent reply other threads:[~2021-05-22 11:34 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-20 18:21 [PATCH] Phonet: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-20 18:30 ` Randy Dunlap
2021-05-22 9:27 ` Rémi Denis-Courmont
2021-05-22 11:26 ` Aditya Srivastava
2021-05-22 11:34 ` Aditya Srivastava [this message]
2021-05-22 15:16 ` [PATCH v2] Phonet: fix kernel-doc syntax in file headers and remove file names Randy Dunlap
2021-05-23 8:11 ` Rémi Denis-Courmont
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210522113408.8766-1-yashsri421@gmail.com \
--to=yashsri421@gmail.com \
--cc=courmisch@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).