All of lore.kernel.org
 help / color / mirror / Atom feed
From: Baokun Li <libaokun1@huawei.com>
To: <rjw@rjwysocki.net>, <len.brown@intel.com>, <pavel@ucw.cz>,
	<linux-pm@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Cc: <weiyongjun1@huawei.com>, <yuehaibing@huawei.com>,
	<yangjihong1@huawei.com>, <yukuai3@huawei.com>,
	<libaokun1@huawei.com>
Subject: [PATCH -next] PM/sleep: fix doc warnings in main.c
Date: Sat, 5 Jun 2021 14:39:34 +0800	[thread overview]
Message-ID: <20210605063934.688763-1-libaokun1@huawei.com> (raw)

Add description for `state_show` to fix the W=1 warnings:

kernel/power/main.c:593: warning:
 Function parameter or member 'kobj' not described in 'state_show'
kernel/power/main.c:593: warning:
 Function parameter or member 'attr' not described in 'state_show'
kernel/power/main.c:593: warning:
 Function parameter or member 'buf' not described in 'state_show'

Signed-off-by: Baokun Li <libaokun1@huawei.com>
---
 kernel/power/main.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/kernel/power/main.c b/kernel/power/main.c
index 12c7e1bb442f..d508c8c582e0 100644
--- a/kernel/power/main.c
+++ b/kernel/power/main.c
@@ -579,7 +579,9 @@ struct kobject *power_kobj;
 
 /**
  * state - control system sleep states.
- *
+ * @kobj: Pointer to the kernel object.
+ * @attr: Pointer to the kernel object attribute.
+ * @buf: buffer.
  * show() returns available sleep state labels, which may be "mem", "standby",
  * "freeze" and "disk" (hibernation).
  * See Documentation/admin-guide/pm/sleep-states.rst for a description of
-- 
2.31.1


             reply	other threads:[~2021-06-05  6:30 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-05  6:39 Baokun Li [this message]
2021-06-07 15:42 ` [PATCH -next] PM/sleep: fix doc warnings in main.c 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=20210605063934.688763-1-libaokun1@huawei.com \
    --to=libaokun1@huawei.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 \
    --cc=weiyongjun1@huawei.com \
    --cc=yangjihong1@huawei.com \
    --cc=yuehaibing@huawei.com \
    --cc=yukuai3@huawei.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.