RCU Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 1/2] rcu: Correct kernel-doc inconsistency
@ 2020-07-19 21:05 Colton Lewis
  2020-07-19 21:05 ` [PATCH 2/2] " Colton Lewis
  2020-07-19 21:33 ` [PATCH 1/2] " Paul E. McKenney
  0 siblings, 2 replies; 3+ messages in thread
From: Colton Lewis @ 2020-07-19 21:05 UTC (permalink / raw)
  To: paulmck, josh; +Cc: rcu, Colton Lewis

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



^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 2/2] rcu: Correct kernel-doc inconsistency
  2020-07-19 21:05 [PATCH 1/2] rcu: Correct kernel-doc inconsistency Colton Lewis
@ 2020-07-19 21:05 ` Colton Lewis
  2020-07-19 21:33 ` [PATCH 1/2] " Paul E. McKenney
  1 sibling, 0 replies; 3+ messages in thread
From: Colton Lewis @ 2020-07-19 21:05 UTC (permalink / raw)
  To: paulmck, josh; +Cc: rcu, Colton Lewis

Silence documentation build warnings by correcting kernel-doc comment
in hlists_swap_heads_rcu function.

./include/linux/rculist.h:515: warning: bad line:                           [@right ][node2 ... ]

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 include/linux/rculist.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/rculist.h b/include/linux/rculist.h
index df587d181844..7eed65b5f713 100644
--- a/include/linux/rculist.h
+++ b/include/linux/rculist.h
@@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,
  * @right: The hlist head on the right
  *
  * The lists start out as [@left  ][node1 ... ] and
-                          [@right ][node2 ... ]
+ *                        [@right ][node2 ... ]
  * The lists end up as    [@left  ][node2 ... ]
  *                        [@right ][node1 ... ]
  */
-- 
2.26.2



^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH 1/2] rcu: Correct kernel-doc inconsistency
  2020-07-19 21:05 [PATCH 1/2] rcu: Correct kernel-doc inconsistency Colton Lewis
  2020-07-19 21:05 ` [PATCH 2/2] " Colton Lewis
@ 2020-07-19 21:33 ` Paul E. McKenney
  1 sibling, 0 replies; 3+ messages in thread
From: Paul E. McKenney @ 2020-07-19 21:33 UTC (permalink / raw)
  To: Colton Lewis; +Cc: josh, rcu

On Sun, Jul 19, 2020 at 09:05:40PM +0000, Colton Lewis wrote:
> 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>

Good eyes, but someone beat you to this one, and the patch is queued
in -rcu.

							Thanx, Paul

> ---
>  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
> 
> 

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, back to index

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-19 21:05 [PATCH 1/2] rcu: Correct kernel-doc inconsistency Colton Lewis
2020-07-19 21:05 ` [PATCH 2/2] " Colton Lewis
2020-07-19 21:33 ` [PATCH 1/2] " Paul E. McKenney

RCU Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/rcu/0 rcu/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 rcu rcu/ https://lore.kernel.org/rcu \
		rcu@vger.kernel.org
	public-inbox-index rcu

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.rcu


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git