Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-08 Thread Luca Fancellu
> On 8 Apr 2021, at 12:50, Julien Grall wrote: > > > > On 08/04/2021 12:40, Julien Grall wrote: >> Hi Luca, >> On 08/04/2021 12:02, Luca Fancellu wrote: >>> >>> On 7 Apr 2021, at 22:26, Stefano Stabellini wrote: On Wed, 7 Apr 2021, Jan Beulich wrote: > On 07.04.2021 10

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-08 Thread Luca Fancellu
> On 8 Apr 2021, at 12:40, Julien Grall wrote: > > Hi Luca, > > On 08/04/2021 12:02, Luca Fancellu wrote: >>> On 7 Apr 2021, at 22:26, Stefano Stabellini wrote: >>> >>> On Wed, 7 Apr 2021, Jan Beulich wrote: On 07.04.2021 10:42, Luca Fancellu wrote: > Just to be sure that we are in

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-08 Thread Julien Grall
On 08/04/2021 12:40, Julien Grall wrote: Hi Luca, On 08/04/2021 12:02, Luca Fancellu wrote: On 7 Apr 2021, at 22:26, Stefano Stabellini wrote: On Wed, 7 Apr 2021, Jan Beulich wrote: On 07.04.2021 10:42, Luca Fancellu wrote: Just to be sure that we are in the same page, are you suggest

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-08 Thread Julien Grall
Hi Luca, On 08/04/2021 12:02, Luca Fancellu wrote: On 7 Apr 2021, at 22:26, Stefano Stabellini wrote: On Wed, 7 Apr 2021, Jan Beulich wrote: On 07.04.2021 10:42, Luca Fancellu wrote: Just to be sure that we are in the same page, are you suggesting to modify the name In this way? struct

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-08 Thread Jan Beulich
On 08.04.2021 13:02, Luca Fancellu wrote: > > >> On 7 Apr 2021, at 22:26, Stefano Stabellini wrote: >> >> On Wed, 7 Apr 2021, Jan Beulich wrote: >>> On 07.04.2021 10:42, Luca Fancellu wrote: Just to be sure that we are in the same page, are you suggesting to modify the name In th

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-08 Thread Luca Fancellu
> On 7 Apr 2021, at 22:26, Stefano Stabellini wrote: > > On Wed, 7 Apr 2021, Jan Beulich wrote: >> On 07.04.2021 10:42, Luca Fancellu wrote: >>> Just to be sure that we are in the same page, are you suggesting to modify >>> the name >>> In this way? >>> >>> struct gnttab_cache_flush { >>> -

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Jan Beulich
On 07.04.2021 23:26, Stefano Stabellini wrote: > On Wed, 7 Apr 2021, Jan Beulich wrote: >> On 07.04.2021 10:42, Luca Fancellu wrote: >>> Just to be sure that we are in the same page, are you suggesting to modify >>> the name >>> In this way? >>> >>> struct gnttab_cache_flush { >>> -union { >>>

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Stefano Stabellini
On Wed, 7 Apr 2021, Jan Beulich wrote: > On 07.04.2021 10:42, Luca Fancellu wrote: > > Just to be sure that we are in the same page, are you suggesting to modify > > the name > > In this way? > > > > struct gnttab_cache_flush { > > -union { > > +union xen_gnttab_cache_flush_a { > >

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Ian Jackson
Bertrand Marquis writes ("Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h"): > Somehow in the documentation when you have a union you will need to document > that it is a union and the possible entries. I would expect to find the documentation for an ano

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Bertrand Marquis
Hi, > On 7 Apr 2021, at 16:54, Jan Beulich wrote: > > On 07.04.2021 17:29, Bertrand Marquis wrote: >>> On 7 Apr 2021, at 16:19, Ian Jackson wrote: >>> >>> Luca Fancellu writes ("Re: [PATCH 3/3] docs/doxygen: doxygen documentation >>> for

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Bertrand Marquis
Hi Julien, > On 7 Apr 2021, at 16:55, Julien Grall wrote: > > > > On 07/04/2021 16:29, Bertrand Marquis wrote: >> Hi Ian, >>> On 7 Apr 2021, at 16:19, Ian Jackson wrote: >>> >>> Luca Fancellu writes ("Re: [PATCH 3/3] docs/doxygen: dox

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Julien Grall
On 07/04/2021 16:29, Bertrand Marquis wrote: Hi Ian, On 7 Apr 2021, at 16:19, Ian Jackson wrote: Luca Fancellu writes ("Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h"): The problem is that Doxygen can’t generate proper documentation for anonymous union

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Jan Beulich
On 07.04.2021 17:29, Bertrand Marquis wrote: >> On 7 Apr 2021, at 16:19, Ian Jackson wrote: >> >> Luca Fancellu writes ("Re: [PATCH 3/3] docs/doxygen: doxygen documentation >> for grant_table.h"): >>> The problem is that Doxygen can’t generate pr

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Bertrand Marquis
Hi Ian, > On 7 Apr 2021, at 16:19, Ian Jackson wrote: > > Luca Fancellu writes ("Re: [PATCH 3/3] docs/doxygen: doxygen documentation > for grant_table.h"): >> The problem is that Doxygen can’t generate proper documentation for >> anonymous union/structu

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Ian Jackson
Luca Fancellu writes ("Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h"): > The problem is that Doxygen can’t generate proper documentation for anonymous > union/structure, it ends up with warning and/or producing wrong documentation > like > changing

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Luca Fancellu
> On 7 Apr 2021, at 14:56, Julien Grall wrote: > > Hi Luca, > > On 07/04/2021 14:19, Luca Fancellu wrote: >>> On 7 Apr 2021, at 14:13, Julien Grall wrote: >>> >>> Hi, >>> >>> On 06/04/2021 11:36, Luca Fancellu wrote: Modification to include/public/grant_table.h: 1) Change anonymo

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Julien Grall
Hi Luca, On 07/04/2021 14:19, Luca Fancellu wrote: On 7 Apr 2021, at 14:13, Julien Grall wrote: Hi, On 06/04/2021 11:36, Luca Fancellu wrote: Modification to include/public/grant_table.h: 1) Change anonymous structure to be named structure, because doxygen can't deal with them. What

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Luca Fancellu
> On 7 Apr 2021, at 14:13, Julien Grall wrote: > > Hi, > > On 06/04/2021 11:36, Luca Fancellu wrote: >> Modification to include/public/grant_table.h: >> 1) Change anonymous structure to be named structure, >>because doxygen can't deal with them. > > What do you mean by can't deal with th

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Julien Grall
Hi, On 06/04/2021 11:36, Luca Fancellu wrote: Modification to include/public/grant_table.h: 1) Change anonymous structure to be named structure, because doxygen can't deal with them. What do you mean by can't deal with them? I had a quick try with doxygen build and couldn't find any fail

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Jan Beulich
On 07.04.2021 10:42, Luca Fancellu wrote: > Just to be sure that we are in the same page, are you suggesting to modify > the name > In this way? > > struct gnttab_cache_flush { > -union { > +union xen_gnttab_cache_flush_a { > uint64_t dev_bus_addr; > grant_ref_t ref; >

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Luca Fancellu
> On 7 Apr 2021, at 09:10, Jan Beulich wrote: > > On 06.04.2021 23:46, Stefano Stabellini wrote: >> On Tue, 6 Apr 2021, Jan Beulich wrote: >>> On 06.04.2021 12:36, Luca Fancellu wrote: Modification to include/public/grant_table.h: 1) Change anonymous structure to be named struc

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-07 Thread Jan Beulich
On 06.04.2021 23:46, Stefano Stabellini wrote: > On Tue, 6 Apr 2021, Jan Beulich wrote: >> On 06.04.2021 12:36, Luca Fancellu wrote: >>> Modification to include/public/grant_table.h: >>> >>> 1) Change anonymous structure to be named structure, >>>because doxygen can't deal with them. >> >> Espe

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-06 Thread Stefano Stabellini
On Tue, 6 Apr 2021, Jan Beulich wrote: > On 06.04.2021 12:36, Luca Fancellu wrote: > > Modification to include/public/grant_table.h: > > > > 1) Change anonymous structure to be named structure, > >because doxygen can't deal with them. > > Especially in the form presented (adding further name

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-06 Thread Jan Beulich
On 06.04.2021 12:36, Luca Fancellu wrote: > Modification to include/public/grant_table.h: > > 1) Change anonymous structure to be named structure, >because doxygen can't deal with them. Especially in the form presented (adding further name space clutter for consumers to fall over) I object to

[PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h

2021-04-06 Thread Luca Fancellu
Modification to include/public/grant_table.h: 1) Change anonymous structure to be named structure, because doxygen can't deal with them. 2) Add doxygen tags to: - Create Grant tables section - include variables in the generated documentation 3) Add .rst file for grant table for Arm64 Signed-