Re: [PATCH v6 70/80] rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
On Tue, Oct 13, 2020 at 10:46:08PM +0200, Mauro Carvalho Chehab wrote:
> Em Tue, 13 Oct 2020 09:34:04 -0700
> "Paul E. McKenney" escreveu:
>
> > On Tue, Oct 13, 2020 at 01:54:25PM +0200, Mauro Carvalho Chehab wrote:
> > > Changeset 53c72b590b3a ("rcu/tree: cache specified number of objects")
> > > added new members for struct kfree_rcu_cpu, but didn't add the
> > > corresponding at the kernel-doc markup, as repoted when doing
> > > "make htmldocs":
> > > ./kernel/rcu/tree.c:3113: warning: Function parameter or member
> > > 'bkvcache' not described in 'kfree_rcu_cpu'
> > > ./kernel/rcu/tree.c:3113: warning: Function parameter or member
> > > 'nr_bkv_objs' not described in 'kfree_rcu_cpu'
> > >
> > > So, move the description for bkvcache to kernel-doc, and add a
> > > description for nr_bkv_objs.
> > >
> > > Fixes: 53c72b590b3a ("rcu/tree: cache specified number of objects")
> > > Signed-off-by: Mauro Carvalho Chehab
> >
> > Queued for review and testing, likely target v5.11.
>
> Hi Paul,
>
> I would prefer if we could get those on 5.10, if possible.
> We're aiming to have 5.10 free of docs warnings ;-)
>
> If you prefer, I can send those patches to Linus with your
> ack.
That sounds easier:
Acked-by: Paul E. McKenney
Alan's objection is quite valid, but we will address that issue in a
follow-on patch that will not be on the fast track.
Thanx, Paul
> Regards,
> Mauro
>
> >
> > Thanx, Paul
> >
> > > ---
> > > kernel/rcu/tree.c | 14 ++
> > > 1 file changed, 6 insertions(+), 8 deletions(-)
> > >
> > > diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
> > > index f78ee759af9c..03c54c3478b7 100644
> > > --- a/kernel/rcu/tree.c
> > > +++ b/kernel/rcu/tree.c
> > > @@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {
> > > * @monitor_todo: Tracks whether a @monitor_work delayed work is pending
> > > * @initialized: The @rcu_work fields have been initialized
> > > * @count: Number of objects for which GP not started
> > > + * @bkvcache:
> > > + * A simple cache list that contains objects for reuse purpose.
> > > + * In order to save some per-cpu space the list is singular.
> > > + * Even though it is lockless an access has to be protected by the
> > > + * per-cpu lock.
> > > + * @nr_bkv_objs: number of allocated objects at @bkvcache.
> > > *
> > > * 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
> > > @@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {
> > > bool monitor_todo;
> > > bool initialized;
> > > int count;
> > > -
> > > - /*
> > > - * A simple cache list that contains objects for
> > > - * reuse purpose. In order to save some per-cpu
> > > - * space the list is singular. Even though it is
> > > - * lockless an access has to be protected by the
> > > - * per-cpu lock.
> > > - */
> > > struct llist_head bkvcache;
> > > int nr_bkv_objs;
> > > };
> > > --
> > > 2.26.2
> > >
>
>
>
> Thanks,
> Mauro
Re: [PATCH v6 70/80] rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
Em Tue, 13 Oct 2020 09:34:04 -0700
"Paul E. McKenney" escreveu:
> On Tue, Oct 13, 2020 at 01:54:25PM +0200, Mauro Carvalho Chehab wrote:
> > Changeset 53c72b590b3a ("rcu/tree: cache specified number of objects")
> > added new members for struct kfree_rcu_cpu, but didn't add the
> > corresponding at the kernel-doc markup, as repoted when doing
> > "make htmldocs":
> > ./kernel/rcu/tree.c:3113: warning: Function parameter or member
> > 'bkvcache' not described in 'kfree_rcu_cpu'
> > ./kernel/rcu/tree.c:3113: warning: Function parameter or member
> > 'nr_bkv_objs' not described in 'kfree_rcu_cpu'
> >
> > So, move the description for bkvcache to kernel-doc, and add a
> > description for nr_bkv_objs.
> >
> > Fixes: 53c72b590b3a ("rcu/tree: cache specified number of objects")
> > Signed-off-by: Mauro Carvalho Chehab
>
> Queued for review and testing, likely target v5.11.
Hi Paul,
I would prefer if we could get those on 5.10, if possible.
We're aiming to have 5.10 free of docs warnings ;-)
If you prefer, I can send those patches to Linus with your
ack.
Regards,
Mauro
>
> Thanx, Paul
>
> > ---
> > kernel/rcu/tree.c | 14 ++
> > 1 file changed, 6 insertions(+), 8 deletions(-)
> >
> > diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
> > index f78ee759af9c..03c54c3478b7 100644
> > --- a/kernel/rcu/tree.c
> > +++ b/kernel/rcu/tree.c
> > @@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {
> > * @monitor_todo: Tracks whether a @monitor_work delayed work is pending
> > * @initialized: The @rcu_work fields have been initialized
> > * @count: Number of objects for which GP not started
> > + * @bkvcache:
> > + * A simple cache list that contains objects for reuse purpose.
> > + * In order to save some per-cpu space the list is singular.
> > + * Even though it is lockless an access has to be protected by the
> > + * per-cpu lock.
> > + * @nr_bkv_objs: number of allocated objects at @bkvcache.
> > *
> > * 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
> > @@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {
> > bool monitor_todo;
> > bool initialized;
> > int count;
> > -
> > - /*
> > -* A simple cache list that contains objects for
> > -* reuse purpose. In order to save some per-cpu
> > -* space the list is singular. Even though it is
> > -* lockless an access has to be protected by the
> > -* per-cpu lock.
> > -*/
> > struct llist_head bkvcache;
> > int nr_bkv_objs;
> > };
> > --
> > 2.26.2
> >
Thanks,
Mauro
Re: [PATCH v6 70/80] rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
On Tue, Oct 13, 2020 at 01:54:25PM +0200, Mauro Carvalho Chehab wrote:
> Changeset 53c72b590b3a ("rcu/tree: cache specified number of objects")
> added new members for struct kfree_rcu_cpu, but didn't add the
> corresponding at the kernel-doc markup, as repoted when doing
> "make htmldocs":
> ./kernel/rcu/tree.c:3113: warning: Function parameter or member
> 'bkvcache' not described in 'kfree_rcu_cpu'
> ./kernel/rcu/tree.c:3113: warning: Function parameter or member
> 'nr_bkv_objs' not described in 'kfree_rcu_cpu'
>
> So, move the description for bkvcache to kernel-doc, and add a
> description for nr_bkv_objs.
>
> Fixes: 53c72b590b3a ("rcu/tree: cache specified number of objects")
> Signed-off-by: Mauro Carvalho Chehab
Queued for review and testing, likely target v5.11.
Thanx, Paul
> ---
> kernel/rcu/tree.c | 14 ++
> 1 file changed, 6 insertions(+), 8 deletions(-)
>
> diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
> index f78ee759af9c..03c54c3478b7 100644
> --- a/kernel/rcu/tree.c
> +++ b/kernel/rcu/tree.c
> @@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {
> * @monitor_todo: Tracks whether a @monitor_work delayed work is pending
> * @initialized: The @rcu_work fields have been initialized
> * @count: Number of objects for which GP not started
> + * @bkvcache:
> + * A simple cache list that contains objects for reuse purpose.
> + * In order to save some per-cpu space the list is singular.
> + * Even though it is lockless an access has to be protected by the
> + * per-cpu lock.
> + * @nr_bkv_objs: number of allocated objects at @bkvcache.
> *
> * 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
> @@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {
> bool monitor_todo;
> bool initialized;
> int count;
> -
> - /*
> - * A simple cache list that contains objects for
> - * reuse purpose. In order to save some per-cpu
> - * space the list is singular. Even though it is
> - * lockless an access has to be protected by the
> - * per-cpu lock.
> - */
> struct llist_head bkvcache;
> int nr_bkv_objs;
> };
> --
> 2.26.2
>
[PATCH v6 70/80] rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
Changeset 53c72b590b3a ("rcu/tree: cache specified number of objects")
added new members for struct kfree_rcu_cpu, but didn't add the
corresponding at the kernel-doc markup, as repoted when doing
"make htmldocs":
./kernel/rcu/tree.c:3113: warning: Function parameter or member
'bkvcache' not described in 'kfree_rcu_cpu'
./kernel/rcu/tree.c:3113: warning: Function parameter or member
'nr_bkv_objs' not described in 'kfree_rcu_cpu'
So, move the description for bkvcache to kernel-doc, and add a
description for nr_bkv_objs.
Fixes: 53c72b590b3a ("rcu/tree: cache specified number of objects")
Signed-off-by: Mauro Carvalho Chehab
---
kernel/rcu/tree.c | 14 ++
1 file changed, 6 insertions(+), 8 deletions(-)
diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index f78ee759af9c..03c54c3478b7 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {
* @monitor_todo: Tracks whether a @monitor_work delayed work is pending
* @initialized: The @rcu_work fields have been initialized
* @count: Number of objects for which GP not started
+ * @bkvcache:
+ * A simple cache list that contains objects for reuse purpose.
+ * In order to save some per-cpu space the list is singular.
+ * Even though it is lockless an access has to be protected by the
+ * per-cpu lock.
+ * @nr_bkv_objs: number of allocated objects at @bkvcache.
*
* 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
@@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {
bool monitor_todo;
bool initialized;
int count;
-
- /*
-* A simple cache list that contains objects for
-* reuse purpose. In order to save some per-cpu
-* space the list is singular. Even though it is
-* lockless an access has to be protected by the
-* per-cpu lock.
-*/
struct llist_head bkvcache;
int nr_bkv_objs;
};
--
2.26.2
