* [PATCH] rcu: Make it stop complaining about docbook function-header comment
@ 2018-06-25 6:26 Byungchul Park
2018-06-25 15:39 ` Paul E. McKenney
0 siblings, 1 reply; 2+ messages in thread
From: Byungchul Park @ 2018-06-25 6:26 UTC (permalink / raw)
To: jiangshanlai, paulmck, josh, rostedt, mathieu.desnoyers
Cc: linux-kernel, kernel-team, joel
Running "make htmldocs" complains about the docbook function-header
comment. It wants the "irq" parameter described which wasn't done by
a commit 5e5ea52645b197 (rcu: Refactor rcu_{nmi,irq}_{enter,exit}()).
So add its description of the parameter to the comment.
Suggested-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Signed-off-by: Byungchul Park <byungchul.park@lge.com>
---
kernel/rcu/tree.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index 4ed74f1..6c5a7f0 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -774,6 +774,7 @@ void rcu_user_enter(void)
/**
* rcu_nmi_exit_common - inform RCU of exit from NMI context
+ * @irq: Is this call from rcu_irq_exit?
*
* If we are returning from the outermost NMI handler that interrupted an
* RCU-idle period, update rdtp->dynticks and rdtp->dynticks_nmi_nesting
@@ -933,6 +934,7 @@ void rcu_user_exit(void)
/**
* rcu_nmi_enter_common - 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 rdtp->dynticks and
* rdtp->dynticks_nmi_nesting to let the RCU grace-period handling know
--
1.9.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] rcu: Make it stop complaining about docbook function-header comment
2018-06-25 6:26 [PATCH] rcu: Make it stop complaining about docbook function-header comment Byungchul Park
@ 2018-06-25 15:39 ` Paul E. McKenney
0 siblings, 0 replies; 2+ messages in thread
From: Paul E. McKenney @ 2018-06-25 15:39 UTC (permalink / raw)
To: Byungchul Park
Cc: jiangshanlai, josh, rostedt, mathieu.desnoyers, linux-kernel,
kernel-team, joel
On Mon, Jun 25, 2018 at 03:26:55PM +0900, Byungchul Park wrote:
> Running "make htmldocs" complains about the docbook function-header
> comment. It wants the "irq" parameter described which wasn't done by
> a commit 5e5ea52645b197 (rcu: Refactor rcu_{nmi,irq}_{enter,exit}()).
> So add its description of the parameter to the comment.
>
> Suggested-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
> Signed-off-by: Byungchul Park <byungchul.park@lge.com>
Very good, I will squash this into your previous patch, adding to the
commit log as suggested by Steven Rostedt.
Thanx, Paul
> ---
> kernel/rcu/tree.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
> index 4ed74f1..6c5a7f0 100644
> --- a/kernel/rcu/tree.c
> +++ b/kernel/rcu/tree.c
> @@ -774,6 +774,7 @@ void rcu_user_enter(void)
>
> /**
> * rcu_nmi_exit_common - inform RCU of exit from NMI context
> + * @irq: Is this call from rcu_irq_exit?
> *
> * If we are returning from the outermost NMI handler that interrupted an
> * RCU-idle period, update rdtp->dynticks and rdtp->dynticks_nmi_nesting
> @@ -933,6 +934,7 @@ void rcu_user_exit(void)
>
> /**
> * rcu_nmi_enter_common - 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 rdtp->dynticks and
> * rdtp->dynticks_nmi_nesting to let the RCU grace-period handling know
> --
> 1.9.1
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-06-25 15:38 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-06-25 6:26 [PATCH] rcu: Make it stop complaining about docbook function-header comment Byungchul Park
2018-06-25 15:39 ` Paul E. McKenney
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).