[v5,15/18] Documentation: Split doxygen_input in public and internal inputs
diff mbox series

Message ID 20240805143654.20870-16-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Split libcamera documentation in public and internal APIs
Related show

Commit Message

Laurent Pinchart Aug. 5, 2024, 2:36 p.m. UTC
To prepare for splitting the API documentation in public and internal
documents, split the doxygen_input list in the public and internal
counterparts.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/meson.build | 25 ++++++++++++++++---------
 1 file changed, 16 insertions(+), 9 deletions(-)

Comments

Dan Scally Aug. 7, 2024, 8:49 a.m. UTC | #1
Hi Laurent

On 05/08/2024 15:36, Laurent Pinchart wrote:
> To prepare for splitting the API documentation in public and internal
> documents, split the doxygen_input list in the public and internal
> counterparts.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
>   Documentation/meson.build | 25 ++++++++++++++++---------
>   1 file changed, 16 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index 070420715bd1..1d84ed815b50 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -28,27 +28,34 @@ if doxygen.found() and dot.found()
>                                 output : 'Doxyfile',
>                                 configuration : cdata)
>   
> -    doxygen_input = [
> -        doxyfile,
> -        libcamera_base_headers,
> +    doxygen_public_input = [
> +        libcamera_base_public_headers,
>           libcamera_base_public_sources,
> -        libcamera_base_internal_sources,
> -        libcamera_internal_headers,
> -        libcamera_ipa_headers,
> -        libcamera_ipa_interfaces,
>           libcamera_public_headers,
>           libcamera_public_sources,
> +    ]
> +
> +    doxygen_internal_input = [
> +        libcamera_base_private_headers,
> +        libcamera_base_internal_sources,
> +        libcamera_internal_headers,
>           libcamera_internal_sources,
> +        libcamera_ipa_headers,
> +        libcamera_ipa_interfaces,
>           libipa_headers,
>           libipa_sources,
>       ]
>   
>       if is_variable('ipu3_ipa_sources')
> -        doxygen_input += [ipu3_ipa_sources]
> +        doxygen_internal_input += [ipu3_ipa_sources]
>       endif
>   
>       custom_target('doxygen',
> -                  input : doxygen_input,
> +                  input : [
> +                      doxyfile,
> +                      doxygen_public_input,
> +                      doxygen_internal_input,
> +                  ],
>                     output : 'api-html',
>                     command : [doxygen, doxyfile],
>                     install : true,
Kieran Bingham Aug. 7, 2024, 11:33 a.m. UTC | #2
Quoting Laurent Pinchart (2024-08-05 15:36:51)
> To prepare for splitting the API documentation in public and internal
> documents, split the doxygen_input list in the public and internal
> counterparts.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/meson.build | 25 ++++++++++++++++---------
>  1 file changed, 16 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index 070420715bd1..1d84ed815b50 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -28,27 +28,34 @@ if doxygen.found() and dot.found()
>                                output : 'Doxyfile',
>                                configuration : cdata)
>  
> -    doxygen_input = [
> -        doxyfile,
> -        libcamera_base_headers,

$ git grep libcamera_base_headers
Documentation/meson.build:        libcamera_base_headers,
include/libcamera/base/meson.build:libcamera_base_headers = [
src/libcamera/base/meson.build:                                    [libcamera_base_sources, libcamera_base_headers],
src/libcamera/base/meson.build:                                        libcamera_base_headers,

I wonder if we should get rid of libcamera_base_headers and
libcamera_base_sources too?


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>


> +    doxygen_public_input = [
> +        libcamera_base_public_headers,
>          libcamera_base_public_sources,
> -        libcamera_base_internal_sources,
> -        libcamera_internal_headers,
> -        libcamera_ipa_headers,
> -        libcamera_ipa_interfaces,
>          libcamera_public_headers,
>          libcamera_public_sources,
> +    ]
> +
> +    doxygen_internal_input = [
> +        libcamera_base_private_headers,
> +        libcamera_base_internal_sources,
> +        libcamera_internal_headers,
>          libcamera_internal_sources,
> +        libcamera_ipa_headers,
> +        libcamera_ipa_interfaces,
>          libipa_headers,
>          libipa_sources,
>      ]
>  
>      if is_variable('ipu3_ipa_sources')
> -        doxygen_input += [ipu3_ipa_sources]
> +        doxygen_internal_input += [ipu3_ipa_sources]
>      endif
>  
>      custom_target('doxygen',
> -                  input : doxygen_input,
> +                  input : [
> +                      doxyfile,
> +                      doxygen_public_input,
> +                      doxygen_internal_input,
> +                  ],
>                    output : 'api-html',
>                    command : [doxygen, doxyfile],
>                    install : true,
> -- 
> Regards,
> 
> Laurent Pinchart
>
Laurent Pinchart Aug. 7, 2024, 1:15 p.m. UTC | #3
On Wed, Aug 07, 2024 at 12:33:13PM +0100, Kieran Bingham wrote:
> Quoting Laurent Pinchart (2024-08-05 15:36:51)
> > To prepare for splitting the API documentation in public and internal
> > documents, split the doxygen_input list in the public and internal
> > counterparts.
> > 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> >  Documentation/meson.build | 25 ++++++++++++++++---------
> >  1 file changed, 16 insertions(+), 9 deletions(-)
> > 
> > diff --git a/Documentation/meson.build b/Documentation/meson.build
> > index 070420715bd1..1d84ed815b50 100644
> > --- a/Documentation/meson.build
> > +++ b/Documentation/meson.build
> > @@ -28,27 +28,34 @@ if doxygen.found() and dot.found()
> >                                output : 'Doxyfile',
> >                                configuration : cdata)
> >  
> > -    doxygen_input = [
> > -        doxyfile,
> > -        libcamera_base_headers,
> 
> $ git grep libcamera_base_headers
> Documentation/meson.build:        libcamera_base_headers,
> include/libcamera/base/meson.build:libcamera_base_headers = [
> src/libcamera/base/meson.build:                                    [libcamera_base_sources, libcamera_base_headers],
> src/libcamera/base/meson.build:                                        libcamera_base_headers,
> 
> I wonder if we should get rid of libcamera_base_headers and
> libcamera_base_sources too?

libcamera_base_sources is gone, "libcamera: Split public and internal
source arrays" removed it.

As for libcamera_base_headers, we could drop it as none of the base
headers are generated, so there's no need to specify explicit
dependencies as far as I can tell. That should go in a separate patch
though.

> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> > +    doxygen_public_input = [
> > +        libcamera_base_public_headers,
> >          libcamera_base_public_sources,
> > -        libcamera_base_internal_sources,
> > -        libcamera_internal_headers,
> > -        libcamera_ipa_headers,
> > -        libcamera_ipa_interfaces,
> >          libcamera_public_headers,
> >          libcamera_public_sources,
> > +    ]
> > +
> > +    doxygen_internal_input = [
> > +        libcamera_base_private_headers,
> > +        libcamera_base_internal_sources,
> > +        libcamera_internal_headers,
> >          libcamera_internal_sources,
> > +        libcamera_ipa_headers,
> > +        libcamera_ipa_interfaces,
> >          libipa_headers,
> >          libipa_sources,
> >      ]
> >  
> >      if is_variable('ipu3_ipa_sources')
> > -        doxygen_input += [ipu3_ipa_sources]
> > +        doxygen_internal_input += [ipu3_ipa_sources]
> >      endif
> >  
> >      custom_target('doxygen',
> > -                  input : doxygen_input,
> > +                  input : [
> > +                      doxyfile,
> > +                      doxygen_public_input,
> > +                      doxygen_internal_input,
> > +                  ],
> >                    output : 'api-html',
> >                    command : [doxygen, doxyfile],
> >                    install : true,

Patch
diff mbox series

diff --git a/Documentation/meson.build b/Documentation/meson.build
index 070420715bd1..1d84ed815b50 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -28,27 +28,34 @@  if doxygen.found() and dot.found()
                               output : 'Doxyfile',
                               configuration : cdata)
 
-    doxygen_input = [
-        doxyfile,
-        libcamera_base_headers,
+    doxygen_public_input = [
+        libcamera_base_public_headers,
         libcamera_base_public_sources,
-        libcamera_base_internal_sources,
-        libcamera_internal_headers,
-        libcamera_ipa_headers,
-        libcamera_ipa_interfaces,
         libcamera_public_headers,
         libcamera_public_sources,
+    ]
+
+    doxygen_internal_input = [
+        libcamera_base_private_headers,
+        libcamera_base_internal_sources,
+        libcamera_internal_headers,
         libcamera_internal_sources,
+        libcamera_ipa_headers,
+        libcamera_ipa_interfaces,
         libipa_headers,
         libipa_sources,
     ]
 
     if is_variable('ipu3_ipa_sources')
-        doxygen_input += [ipu3_ipa_sources]
+        doxygen_internal_input += [ipu3_ipa_sources]
     endif
 
     custom_target('doxygen',
-                  input : doxygen_input,
+                  input : [
+                      doxyfile,
+                      doxygen_public_input,
+                      doxygen_internal_input,
+                  ],
                   output : 'api-html',
                   command : [doxygen, doxyfile],
                   install : true,