From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Ingo Molnar <mingo@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Will Deacon <will@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
"Jonathan Corbet" <corbet@lwn.net>,
"Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org
Subject: [PATCH 10/10] seqlock: kernel-doc: fix a prototype
Date: Thu, 14 Jan 2021 08:53:45 +0100 [thread overview]
Message-ID: <84693a4901efb553dd95fe4909b50d6d8faf8107.1610610444.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1610610444.git.mchehab+huawei@kernel.org>
Right now, kernel-doc produces a warning:
./include/linux/seqlock.h:829: warning: wrong kernel-doc identifier on line:
* DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
The issue is that Kernel-doc valid syntaxes for function/define
declarations are either:
function_foo - description
or:
function_foo() - description
The function parameters should be declared only afterwards.
So, replace it to:
DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
include/linux/seqlock.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h
index 2f7bb92b4c9e..209454cedf61 100644
--- a/include/linux/seqlock.h
+++ b/include/linux/seqlock.h
@@ -826,7 +826,7 @@ typedef struct {
} while (0)
/**
- * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
+ * DEFINE_SEQLOCK() - Define a statically allocated seqlock_t
* @sl: Name of the seqlock_t instance
*/
#define DEFINE_SEQLOCK(sl) \
--
2.29.2
prev parent reply other threads:[~2021-01-14 7:54 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 01/10] doc/zh_CN: fix Sphinx errors Mauro Carvalho Chehab
2021-01-14 14:40 ` Jonathan Corbet
2021-01-14 7:53 ` [PATCH 02/10] ABI: sysfs-fs-f2fs: fix a table identation Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 03/10] KVM: x86: hyper-v: add a blank line to remove building warnings Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 04/10] ABI: sysfs-firmware-sgi_uv Mauro Carvalho Chehab
2021-01-14 16:09 ` Ernst, Justin
2021-01-14 7:53 ` [PATCH 05/10] docs: fpga: dfl.rst: Fix a couple building issues Mauro Carvalho Chehab
2021-01-14 14:56 ` Tom Rix
2021-01-14 7:53 ` [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup Mauro Carvalho Chehab
2021-01-14 13:50 ` Christian König
2021-01-14 17:40 ` Alex Deucher
2021-01-14 7:53 ` [PATCH 07/10] dwc3: document gadget_max_speed Mauro Carvalho Chehab
2021-01-14 9:02 ` Felipe Balbi
2021-01-14 7:53 ` [PATCH 08/10] doc: zh_CN/mips: fix doc cross-references Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 09/10] media: v4l2-subdev.rst: fix a missing whitespace Mauro Carvalho Chehab
2021-01-14 7:53 ` Mauro Carvalho Chehab [this message]
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=84693a4901efb553dd95fe4909b50d6d8faf8107.1610610444.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=will@kernel.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).