From: Colton Lewis <colton.w.lewis@protonmail.com>
To: paulmck@kernel.org, josh@joshtriplett.org
Cc: rcu@vger.kernel.org, Colton Lewis <colton.w.lewis@protonmail.com>
Subject: [PATCH 1/2] rcu: Correct kernel-doc inconsistency
Date: Sun, 19 Jul 2020 21:05:40 +0000 [thread overview]
Message-ID: <20200719210533.152080-1-colton.w.lewis@protonmail.com> (raw)
Silence documentation build warnings by correcting kernel-doc comment
for rcu_nmi_enter function and kfree_rcu_cpu struct.
./kernel/rcu/tree.c:969: warning: Excess function parameter 'irq' description in 'rcu_nmi_enter'
./kernel/rcu/tree.c:3024: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'
Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
kernel/rcu/tree.c | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index 6c6569e0586c..f38a51b96027 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -954,7 +954,6 @@ void __rcu_irq_enter_check_tick(void)
/**
* rcu_nmi_enter - inform RCU of entry to NMI context
- * @irq: Is this call from rcu_irq_enter?
*
* If the CPU was idle from RCU's viewpoint, update rdp->dynticks and
* rdp->dynticks_nmi_nesting to let the RCU grace-period handling know
@@ -3004,6 +3003,7 @@ struct kfree_rcu_cpu_work {
* @monitor_work: Promote @head to @head_free after KFREE_DRAIN_JIFFIES
* @monitor_todo: Tracks whether a @monitor_work delayed work is pending
* @initialized: The @lock and @rcu_work fields have been initialized
+ * @count: number of objects for which GP is not started
*
* This is a per-CPU structure. The reason that it is not included in
* the rcu_data structure is to permit this code to be extracted from
@@ -3019,7 +3019,6 @@ struct kfree_rcu_cpu {
struct delayed_work monitor_work;
bool monitor_todo;
bool initialized;
- // Number of objects for which GP not started
int count;
};
--
2.26.2
next reply other threads:[~2020-07-19 21:05 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-19 21:05 Colton Lewis [this message]
2020-07-19 21:05 ` [PATCH 2/2] rcu: Correct kernel-doc inconsistency Colton Lewis
2020-07-19 21:33 ` [PATCH 1/2] " Paul E. McKenney
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=20200719210533.152080-1-colton.w.lewis@protonmail.com \
--to=colton.w.lewis@protonmail.com \
--cc=josh@joshtriplett.org \
--cc=paulmck@kernel.org \
--cc=rcu@vger.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).