From: Alex Shi <alex.shi@linux.alibaba.com>
To: unlisted-recipients:; (no To-header on input)
Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>,
Len Brown <len.brown@intel.com>, Pavel Machek <pavel@ucw.cz>,
linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] PM / suspend: fix kernel-doc markup
Date: Fri, 13 Nov 2020 16:58:10 +0800 [thread overview]
Message-ID: <1605257895-5536-1-git-send-email-alex.shi@linux.alibaba.com> (raw)
Add parameter explanation to fix kernel-doc marks:
kernel/power/suspend.c:233: warning: Function parameter or member
'state' not described in 'suspend_valid_only_mem'
kernel/power/suspend.c:344: warning: Function parameter or member
'state' not described in 'suspend_prepare'
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
Cc: Len Brown <len.brown@intel.com>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: linux-pm@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
---
kernel/power/suspend.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/kernel/power/suspend.c b/kernel/power/suspend.c
index 32391acc806b..502d86ed99c7 100644
--- a/kernel/power/suspend.c
+++ b/kernel/power/suspend.c
@@ -224,6 +224,7 @@ EXPORT_SYMBOL_GPL(suspend_set_ops);
/**
* suspend_valid_only_mem - Generic memory-only valid callback.
+ * @state: Suspend state to be set
*
* Platform drivers that implement mem suspend only and only need to check for
* that in their .valid() callback can use this instead of rolling their own
@@ -335,6 +336,7 @@ static int suspend_test(int level)
/**
* suspend_prepare - Prepare for entering system sleep state.
+ * @state: suspend state which sleep from
*
* Common code run for every system sleep state that can be entered (except for
* hibernation). Run suspend notifiers, allocate the "suspend" console and
--
2.29.GIT
next reply other threads:[~2020-11-13 8:58 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-13 8:58 Alex Shi [this message]
2020-11-13 8:58 ` [PATCH] locking/rtmutex: add missed kernel-doc markup Alex Shi
2021-01-12 13:28 ` Will Deacon
2021-01-27 19:31 ` [tip: locking/core] locking/rtmutex: Add missing " tip-bot2 for Alex Shi
2021-01-28 12:21 ` tip-bot2 for Alex Shi
2020-11-13 8:58 ` [PATCH] locking/rtmutex: remove useless parameter for rt_mutex_proxy_unlock Alex Shi
2021-01-12 13:31 ` Will Deacon
2020-11-13 8:58 ` [PATCH] configfs: fix kernel-doc markup issue Alex Shi
2020-11-14 9:26 ` Christoph Hellwig
2020-11-13 8:58 ` [PATCH] x86/PCI: fix a comments issue Alex Shi
2020-11-27 13:06 ` [tip: x86/cleanups] x86/PCI: Make a kernel-doc comment a normal one tip-bot2 for Alex Shi
2020-11-13 8:58 ` [PATCH] PKCS#7: drop function from kernel-doc pkcs7_validate_trust_one Alex Shi
2020-11-23 17:26 ` [PATCH] PM / suspend: fix kernel-doc markup Rafael J. Wysocki
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=1605257895-5536-1-git-send-email-alex.shi@linux.alibaba.com \
--to=alex.shi@linux.alibaba.com \
--cc=len.brown@intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=pavel@ucw.cz \
--cc=rjw@rjwysocki.net \
/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).