From: "Milan Lakhani" <milan.lakhani@codethink.co.uk>
To: lukas.bulwahn@gmail.com, sudip.mukherjee@codethink.co.uk,
linux-kernel@vger.kernel.org, linux-safety@lists.elisa.tech,
corbet@lwn.net
Cc: Milan Lakhani <milan.lakhani@codethink.co.uk>
Subject: [linux-safety] [PATCH] include/linux/build_bug.h: Add documentation
Date: Wed, 10 Feb 2021 22:21:55 +0000 [thread overview]
Message-ID: <1612995715-37324-1-git-send-email-milan.lakhani@codethink.co.uk> (raw)
Add missing documentation describing function parameters of macros,
thus removing warnings.
Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>
---
include/linux/build_bug.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/include/linux/build_bug.h b/include/linux/build_bug.h
index e3a0be2..457c5f2 100644
--- a/include/linux/build_bug.h
+++ b/include/linux/build_bug.h
@@ -32,7 +32,8 @@
/**
* BUILD_BUG_ON_MSG - break compile if a condition is true & emit supplied
* error message.
- * @condition: the condition which the compiler should know is false.
+ * @cond: the condition which the compiler should know is false.
+ * @msg: the error message to show when the condition is true.
*
* See BUILD_BUG_ON for description.
*/
@@ -60,6 +61,8 @@
/**
* static_assert - check integer constant expression at build time
+ * @expr: the integer constant expression which the compiler should know is
+ * true.
*
* static_assert() is a wrapper for the C11 _Static_assert, with a
* little macro magic to make the message optional (defaulting to the
--
2.7.4
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#239): https://lists.elisa.tech/g/linux-safety/message/239
Mute This Topic: https://lists.elisa.tech/mt/80544677/5278000
Group Owner: linux-safety+owner@lists.elisa.tech
Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org]
-=-=-=-=-=-=-=-=-=-=-=-
reply other threads:[~2021-02-10 22:22 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=1612995715-37324-1-git-send-email-milan.lakhani@codethink.co.uk \
--to=milan.lakhani@codethink.co.uk \
--cc=corbet@lwn.net \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-safety@lists.elisa.tech \
--cc=lukas.bulwahn@gmail.com \
--cc=sudip.mukherjee@codethink.co.uk \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).