[v1] Documentation: Make `doxygen-internal` depend on public inputs
diff mbox series

Message ID 20250715134407.187697-1-barnabas.pocze@ideasonboard.com
State Accepted
Headers show
Series
  • [v1] Documentation: Make `doxygen-internal` depend on public inputs
Related show

Commit Message

Barnabás Pőcze July 15, 2025, 1:44 p.m. UTC
The internal documentation is a superset of the public one, so make the
`doxygen-internal` target depend on the public input files. Otherwise
the internal documentation is not rebuilt if a "public"file changes.

Before:

 $ touch src/libcamera/camera.cpp
 $ ninja -C build -v
 # ...
 [6/116] /usr/bin/doxygen Documentation/Doxyfile-public
 # ...

After:

 $ touch src/libcamera/camera.cpp
 $ ninja -C build -v
 # ...
 [6/117] /usr/bin/doxygen Documentation/Doxyfile-public
 # ...
 [9/117] /usr/bin/doxygen Documentation/Doxyfile-internal
 # ...

Signed-off-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>
---
 Documentation/meson.build | 1 +
 1 file changed, 1 insertion(+)

--
2.50.1

Comments

Dan Scally July 15, 2025, 2:19 p.m. UTC | #1
Hi Barnabás

On 15/07/2025 14:44, Barnabás Pőcze wrote:
> The internal documentation is a superset of the public one, so make the
> `doxygen-internal` target depend on the public input files. Otherwise
> the internal documentation is not rebuilt if a "public"file changes.
>
> Before:
>
>   $ touch src/libcamera/camera.cpp
>   $ ninja -C build -v
>   # ...
>   [6/116] /usr/bin/doxygen Documentation/Doxyfile-public
>   # ...
>
> After:
>
>   $ touch src/libcamera/camera.cpp
>   $ ninja -C build -v
>   # ...
>   [6/117] /usr/bin/doxygen Documentation/Doxyfile-public
>   # ...
>   [9/117] /usr/bin/doxygen Documentation/Doxyfile-internal
>   # ...
>
> Signed-off-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>
> ---

Whoops. Good spot:


Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>

>   Documentation/meson.build | 1 +
>   1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index 0fc5909d0..3afdcc1a8 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -103,6 +103,7 @@ if doxygen.found() and dot.found()
>                     input : [
>                         doxyfile,
>                         doxyfile_common,
> +                      doxygen_public_input,
>                         doxygen_internal_input,
>                     ],
>                     output : 'internal-api-html',
> --
> 2.50.1
Kieran Bingham July 15, 2025, 3:13 p.m. UTC | #2
Quoting Dan Scally (2025-07-15 15:19:45)
> Hi Barnabás
> 
> On 15/07/2025 14:44, Barnabás Pőcze wrote:
> > The internal documentation is a superset of the public one, so make the
> > `doxygen-internal` target depend on the public input files. Otherwise
> > the internal documentation is not rebuilt if a "public"file changes.
> >
> > Before:
> >
> >   $ touch src/libcamera/camera.cpp
> >   $ ninja -C build -v
> >   # ...
> >   [6/116] /usr/bin/doxygen Documentation/Doxyfile-public
> >   # ...
> >
> > After:
> >
> >   $ touch src/libcamera/camera.cpp
> >   $ ninja -C build -v
> >   # ...
> >   [6/117] /usr/bin/doxygen Documentation/Doxyfile-public
> >   # ...
> >   [9/117] /usr/bin/doxygen Documentation/Doxyfile-internal
> >   # ...
> >
> > Signed-off-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>
> > ---
> 
> Whoops. Good spot:
> 
> 
> Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>

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

> 
> >   Documentation/meson.build | 1 +
> >   1 file changed, 1 insertion(+)
> >
> > diff --git a/Documentation/meson.build b/Documentation/meson.build
> > index 0fc5909d0..3afdcc1a8 100644
> > --- a/Documentation/meson.build
> > +++ b/Documentation/meson.build
> > @@ -103,6 +103,7 @@ if doxygen.found() and dot.found()
> >                     input : [
> >                         doxyfile,
> >                         doxyfile_common,
> > +                      doxygen_public_input,
> >                         doxygen_internal_input,
> >                     ],
> >                     output : 'internal-api-html',
> > --
> > 2.50.1

Patch
diff mbox series

diff --git a/Documentation/meson.build b/Documentation/meson.build
index 0fc5909d0..3afdcc1a8 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -103,6 +103,7 @@  if doxygen.found() and dot.found()
                   input : [
                       doxyfile,
                       doxyfile_common,
+                      doxygen_public_input,
                       doxygen_internal_input,
                   ],
                   output : 'internal-api-html',