* [PATCH 1/1] dm: core: describe uclass_root_s
@ 2021-01-16 10:12 Heinrich Schuchardt
2021-01-16 10:59 ` Bin Meng
0 siblings, 1 reply; 5+ messages in thread
From: Heinrich Schuchardt @ 2021-01-16 10:12 UTC (permalink / raw)
To: u-boot
make htmldocs creates a warning:
./include/asm-generic/global_data.h:443:
warning: Function parameter or member 'uclass_root_s'
not described in 'global_data'
Correct the member descriptions.
Fixes: 8a715530bb1f ("dm: core: Allow the uclass list to move")
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
include/asm-generic/global_data.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/include/asm-generic/global_data.h b/include/asm-generic/global_data.h
index efa09a1943..9fa9a17003 100644
--- a/include/asm-generic/global_data.h
+++ b/include/asm-generic/global_data.h
@@ -198,13 +198,13 @@ struct global_data {
*/
struct udevice *dm_root_f;
/**
- * @uclass_root: head of core tree
+ * @uclass_root_s: static head of core tree, if uclasses are in
+ * read-only memory and cannot be adjusted to use @uclass_root as a
+ * list head.
*/
struct list_head uclass_root_s;
/**
- * @uclass_root: pointer to head of core tree, if uclasses are in
- * read-only memory and cannot be adjusted to use @uclass_root as a
- * list head.
+ * @uclass_root: pointer to the head of core tree
*/
struct list_head *uclass_root;
# if CONFIG_IS_ENABLED(OF_PLATDATA)
--
2.29.2
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 1/1] dm: core: describe uclass_root_s
2021-01-16 10:12 [PATCH 1/1] dm: core: describe uclass_root_s Heinrich Schuchardt
@ 2021-01-16 10:59 ` Bin Meng
2021-01-19 0:49 ` Simon Glass
0 siblings, 1 reply; 5+ messages in thread
From: Bin Meng @ 2021-01-16 10:59 UTC (permalink / raw)
To: u-boot
On Sat, Jan 16, 2021 at 6:13 PM Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> make htmldocs creates a warning:
>
> ./include/asm-generic/global_data.h:443:
> warning: Function parameter or member 'uclass_root_s'
> not described in 'global_data'
>
> Correct the member descriptions.
>
> Fixes: 8a715530bb1f ("dm: core: Allow the uclass list to move")
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
> include/asm-generic/global_data.h | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/include/asm-generic/global_data.h b/include/asm-generic/global_data.h
> index efa09a1943..9fa9a17003 100644
> --- a/include/asm-generic/global_data.h
> +++ b/include/asm-generic/global_data.h
> @@ -198,13 +198,13 @@ struct global_data {
> */
> struct udevice *dm_root_f;
> /**
> - * @uclass_root: head of core tree
> + * @uclass_root_s: static head of core tree, if uclasses are in
> + * read-only memory and cannot be adjusted to use @uclass_root as a
> + * list head.
> */
> struct list_head uclass_root_s;
_s stands for static?
If so, I suspect the comment was just the opposite?
> /**
> - * @uclass_root: pointer to head of core tree, if uclasses are in
> - * read-only memory and cannot be adjusted to use @uclass_root as a
> - * list head.
> + * @uclass_root: pointer to the head of core tree
> */
> struct list_head *uclass_root;
> # if CONFIG_IS_ENABLED(OF_PLATDATA)
> --
Regards,
Bin
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 1/1] dm: core: describe uclass_root_s
2021-01-16 10:59 ` Bin Meng
@ 2021-01-19 0:49 ` Simon Glass
2021-01-19 3:18 ` Heinrich Schuchardt
0 siblings, 1 reply; 5+ messages in thread
From: Simon Glass @ 2021-01-19 0:49 UTC (permalink / raw)
To: u-boot
Hi Bin,
On Sat, 16 Jan 2021 at 03:59, Bin Meng <bmeng.cn@gmail.com> wrote:
>
> On Sat, Jan 16, 2021 at 6:13 PM Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
> >
> > make htmldocs creates a warning:
> >
> > ./include/asm-generic/global_data.h:443:
> > warning: Function parameter or member 'uclass_root_s'
> > not described in 'global_data'
> >
> > Correct the member descriptions.
> >
> > Fixes: 8a715530bb1f ("dm: core: Allow the uclass list to move")
> > Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> > ---
> > include/asm-generic/global_data.h | 8 ++++----
> > 1 file changed, 4 insertions(+), 4 deletions(-)
> >
> > diff --git a/include/asm-generic/global_data.h b/include/asm-generic/global_data.h
> > index efa09a1943..9fa9a17003 100644
> > --- a/include/asm-generic/global_data.h
> > +++ b/include/asm-generic/global_data.h
> > @@ -198,13 +198,13 @@ struct global_data {
> > */
> > struct udevice *dm_root_f;
> > /**
> > - * @uclass_root: head of core tree
> > + * @uclass_root_s: static head of core tree, if uclasses are in
> > + * read-only memory and cannot be adjusted to use @uclass_root as a
> > + * list head.
> > */
> > struct list_head uclass_root_s;
>
> _s stands for static?
>
> If so, I suspect the comment was just the opposite?
Yes. I inserted the new variable but did not move the comment...
>
> > /**
> > - * @uclass_root: pointer to head of core tree, if uclasses are in
> > - * read-only memory and cannot be adjusted to use @uclass_root as a
> > - * list head.
> > + * @uclass_root: pointer to the head of core tree
> > */
> > struct list_head *uclass_root;
> > # if CONFIG_IS_ENABLED(OF_PLATDATA)
> > --
>
Regards,
Simon
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 1/1] dm: core: describe uclass_root_s
2021-01-19 0:49 ` Simon Glass
@ 2021-01-19 3:18 ` Heinrich Schuchardt
2021-01-21 17:32 ` Simon Glass
0 siblings, 1 reply; 5+ messages in thread
From: Heinrich Schuchardt @ 2021-01-19 3:18 UTC (permalink / raw)
To: u-boot
Am 19. Januar 2021 01:49:28 MEZ schrieb Simon Glass <sjg@chromium.org>:
>Hi Bin,
>
>On Sat, 16 Jan 2021 at 03:59, Bin Meng <bmeng.cn@gmail.com> wrote:
>>
>> On Sat, Jan 16, 2021 at 6:13 PM Heinrich Schuchardt
><xypron.glpk@gmx.de> wrote:
>> >
>> > make htmldocs creates a warning:
>> >
>> > ./include/asm-generic/global_data.h:443:
>> > warning: Function parameter or member 'uclass_root_s'
>> > not described in 'global_data'
>> >
>> > Correct the member descriptions.
>> >
>> > Fixes: 8a715530bb1f ("dm: core: Allow the uclass list to move")
>> > Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
>> > ---
>> > include/asm-generic/global_data.h | 8 ++++----
>> > 1 file changed, 4 insertions(+), 4 deletions(-)
>> >
>> > diff --git a/include/asm-generic/global_data.h
>b/include/asm-generic/global_data.h
>> > index efa09a1943..9fa9a17003 100644
>> > --- a/include/asm-generic/global_data.h
>> > +++ b/include/asm-generic/global_data.h
>> > @@ -198,13 +198,13 @@ struct global_data {
>> > */
>> > struct udevice *dm_root_f;
>> > /**
>> > - * @uclass_root: head of core tree
>> > + * @uclass_root_s: static head of core tree, if uclasses
>are in
>> > + * read-only memory and cannot be adjusted to use
>@uclass_root as a
>> > + * list head.
>> > */
>> > struct list_head uclass_root_s;
>>
>> _s stands for static?
>>
>> If so, I suspect the comment was just the opposite?
>
>Yes. I inserted the new variable but did not move the comment...
>
Hello Simon,
do you mean the patch is wrong?
What should the comments look like?
Best regards
Heinrich
>
>>
>> > /**
>> > - * @uclass_root: pointer to head of core tree, if uclasses
>are in
>> > - * read-only memory and cannot be adjusted to use
>@uclass_root as a
>> > - * list head.
>> > + * @uclass_root: pointer to the head of core tree
>> > */
>> > struct list_head *uclass_root;
>> > # if CONFIG_IS_ENABLED(OF_PLATDATA)
>> > --
>>
>
>Regards,
>Simon
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 1/1] dm: core: describe uclass_root_s
2021-01-19 3:18 ` Heinrich Schuchardt
@ 2021-01-21 17:32 ` Simon Glass
0 siblings, 0 replies; 5+ messages in thread
From: Simon Glass @ 2021-01-21 17:32 UTC (permalink / raw)
To: u-boot
Hi Heinrich,
On Mon, 18 Jan 2021 at 20:18, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Am 19. Januar 2021 01:49:28 MEZ schrieb Simon Glass <sjg@chromium.org>:
> >Hi Bin,
> >
> >On Sat, 16 Jan 2021 at 03:59, Bin Meng <bmeng.cn@gmail.com> wrote:
> >>
> >> On Sat, Jan 16, 2021 at 6:13 PM Heinrich Schuchardt
> ><xypron.glpk@gmx.de> wrote:
> >> >
> >> > make htmldocs creates a warning:
> >> >
> >> > ./include/asm-generic/global_data.h:443:
> >> > warning: Function parameter or member 'uclass_root_s'
> >> > not described in 'global_data'
> >> >
> >> > Correct the member descriptions.
> >> >
> >> > Fixes: 8a715530bb1f ("dm: core: Allow the uclass list to move")
> >> > Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> >> > ---
> >> > include/asm-generic/global_data.h | 8 ++++----
> >> > 1 file changed, 4 insertions(+), 4 deletions(-)
> >> >
> >> > diff --git a/include/asm-generic/global_data.h
> >b/include/asm-generic/global_data.h
> >> > index efa09a1943..9fa9a17003 100644
> >> > --- a/include/asm-generic/global_data.h
> >> > +++ b/include/asm-generic/global_data.h
> >> > @@ -198,13 +198,13 @@ struct global_data {
> >> > */
> >> > struct udevice *dm_root_f;
> >> > /**
> >> > - * @uclass_root: head of core tree
> >> > + * @uclass_root_s: static head of core tree, if uclasses
> >are in
> >> > + * read-only memory and cannot be adjusted to use
> >@uclass_root as a
> >> > + * list head.
> >> > */
> >> > struct list_head uclass_root_s;
> >>
> >> _s stands for static?
> >>
> >> If so, I suspect the comment was just the opposite?
> >
> >Yes. I inserted the new variable but did not move the comment...
> >
>
> Hello Simon,
>
> do you mean the patch is wrong?
>
> What should the comments look like?
>
> Best regards
>
> Heinrich
>
>
> >
> >>
> >> > /**
> >> > - * @uclass_root: pointer to head of core tree, if uclasses
> >are in
> >> > - * read-only memory and cannot be adjusted to use
> >@uclass_root as a
> >> > - * list head.
> >> > + * @uclass_root: pointer to the head of core tree
uclass_root is used when described in the removed lines above.
When uclasses are in read-only memory, uclass_root_s is not used and
uclass_root points to the root node generated by dtoc
When not in read-only memory, uclass_root_s is used to hold the uclass
root, and uclass_root points to &uclass_root_s.
> >> > */
> >> > struct list_head *uclass_root;
> >> > # if CONFIG_IS_ENABLED(OF_PLATDATA)
> >> > --
> >>
>
Regards,
Simon
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2021-01-21 17:32 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-16 10:12 [PATCH 1/1] dm: core: describe uclass_root_s Heinrich Schuchardt
2021-01-16 10:59 ` Bin Meng
2021-01-19 0:49 ` Simon Glass
2021-01-19 3:18 ` Heinrich Schuchardt
2021-01-21 17:32 ` Simon Glass
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.