[libcamera-devel,v3,19/19] Documentation: Include IPU3 in Doxygen build
diff mbox series

Message ID 20211022151218.111966-20-jeanmichel.hautbois@ideasonboard.com
State Changes Requested
Headers show
Series
  • Document IPU3 IPA
Related show

Commit Message

Jean-Michel Hautbois Oct. 22, 2021, 3:12 p.m. UTC 
From: Kieran Bingham <kieran.bingham@ideasonboard.com>

The IPU3 is documented using Doxygen within the code.

Include the IPU3 IPA as part of the doxygen build sources. This will
ideally be split to it's own 'section' of the doxygen output.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 Documentation/Doxyfile.in | 1 +
 Documentation/meson.build | 1 +
 2 files changed, 2 insertions(+)

Comments

Laurent Pinchart Oct. 25, 2021, 9:44 p.m. UTC | #1 
Hi Jean-Michel and Kieran,

Thank you for the patch.

On Fri, Oct 22, 2021 at 05:12:18PM +0200, Jean-Michel Hautbois wrote:
> From: Kieran Bingham <kieran.bingham@ideasonboard.com>

Now we have a From: line :-)

> The IPU3 is documented using Doxygen within the code.
> 
> Include the IPU3 IPA as part of the doxygen build sources. This will
> ideally be split to it's own 'section' of the doxygen output.

s/it's/its/

> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> ---
>  Documentation/Doxyfile.in | 1 +
>  Documentation/meson.build | 1 +
>  2 files changed, 2 insertions(+)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index 6e627192..37b231bc 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -790,6 +790,7 @@ WARN_LOGFILE           =
>  
>  INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
>  			 "@TOP_SRCDIR@/src/ipa/libipa" \
> +			 "@TOP_SRCDIR@/src/ipa/ipu3" \

Alphabetical order.

>  			 "@TOP_SRCDIR@/src/libcamera" \
>  			 "@TOP_BUILDDIR@/include/libcamera" \
>  			 "@TOP_BUILDDIR@/src/libcamera"
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index c4bd3c7f..c174c945 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -31,6 +31,7 @@ if doxygen.found() and dot.found()
>                        libcamera_sources,
>                        libipa_headers,
>                        libipa_sources,
> +                      ipu3_ipa_sources,

Same.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

>                    ],
>                    output : 'api-html',
>                    command : [doxygen, doxyfile],
Kieran Bingham Oct. 25, 2021, 9:56 p.m. UTC | #2 
Quoting Laurent Pinchart (2021-10-25 22:44:54)
> Hi Jean-Michel and Kieran,
> 
> Thank you for the patch.
> 
> On Fri, Oct 22, 2021 at 05:12:18PM +0200, Jean-Michel Hautbois wrote:
> > From: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> Now we have a From: line :-)
> 
> > The IPU3 is documented using Doxygen within the code.
> > 
> > Include the IPU3 IPA as part of the doxygen build sources. This will
> > ideally be split to it's own 'section' of the doxygen output.
> 
> s/it's/its/

I bet you'd know /it's/ from me with that in there anyway ;-)
It's always me when it's it's isn't it's.

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

This should still have an SoB from anyone it goes through though, so as
it's gone through you JM, it needs your SoB. (Same for any others).


> > ---
> >  Documentation/Doxyfile.in | 1 +
> >  Documentation/meson.build | 1 +
> >  2 files changed, 2 insertions(+)
> > 
> > diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> > index 6e627192..37b231bc 100644
> > --- a/Documentation/Doxyfile.in
> > +++ b/Documentation/Doxyfile.in
> > @@ -790,6 +790,7 @@ WARN_LOGFILE           =
> >  
> >  INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
> >                        "@TOP_SRCDIR@/src/ipa/libipa" \
> > +                      "@TOP_SRCDIR@/src/ipa/ipu3" \
> 
> Alphabetical order.
> 
> >                        "@TOP_SRCDIR@/src/libcamera" \
> >                        "@TOP_BUILDDIR@/include/libcamera" \
> >                        "@TOP_BUILDDIR@/src/libcamera"
> > diff --git a/Documentation/meson.build b/Documentation/meson.build
> > index c4bd3c7f..c174c945 100644
> > --- a/Documentation/meson.build
> > +++ b/Documentation/meson.build
> > @@ -31,6 +31,7 @@ if doxygen.found() and dot.found()
> >                        libcamera_sources,
> >                        libipa_headers,
> >                        libipa_sources,
> > +                      ipu3_ipa_sources,
> 
> Same.
> 
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
> >                    ],
> >                    output : 'api-html',
> >                    command : [doxygen, doxyfile],
> 
> -- 
> Regards,
> 
> Laurent Pinchart
Laurent Pinchart Oct. 25, 2021, 9:59 p.m. UTC | #3 
On Mon, Oct 25, 2021 at 10:56:54PM +0100, Kieran Bingham wrote:
> Quoting Laurent Pinchart (2021-10-25 22:44:54)
> > Hi Jean-Michel and Kieran,
> > 
> > Thank you for the patch.
> > 
> > On Fri, Oct 22, 2021 at 05:12:18PM +0200, Jean-Michel Hautbois wrote:
> > > From: Kieran Bingham <kieran.bingham@ideasonboard.com>
> > 
> > Now we have a From: line :-)
> > 
> > > The IPU3 is documented using Doxygen within the code.
> > > 
> > > Include the IPU3 IPA as part of the doxygen build sources. This will
> > > ideally be split to it's own 'section' of the doxygen output.
> > 
> > s/it's/its/
> 
> I bet you'd know /it's/ from me with that in there anyway ;-)
> It's always me when it's it's isn't it's.
> 
> > 
> > > Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> This should still have an SoB from anyone it goes through though, so as
> it's gone through you JM, it needs your SoB. (Same for any others).

Not for the mere act of reposting the patch unmodified. An SoB should be
added when the poster modifies the patch, or when a committer commits
the patch to a git tree.

> > > ---
> > >  Documentation/Doxyfile.in | 1 +
> > >  Documentation/meson.build | 1 +
> > >  2 files changed, 2 insertions(+)
> > > 
> > > diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> > > index 6e627192..37b231bc 100644
> > > --- a/Documentation/Doxyfile.in
> > > +++ b/Documentation/Doxyfile.in
> > > @@ -790,6 +790,7 @@ WARN_LOGFILE           =
> > >  
> > >  INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
> > >                        "@TOP_SRCDIR@/src/ipa/libipa" \
> > > +                      "@TOP_SRCDIR@/src/ipa/ipu3" \
> > 
> > Alphabetical order.
> > 
> > >                        "@TOP_SRCDIR@/src/libcamera" \
> > >                        "@TOP_BUILDDIR@/include/libcamera" \
> > >                        "@TOP_BUILDDIR@/src/libcamera"
> > > diff --git a/Documentation/meson.build b/Documentation/meson.build
> > > index c4bd3c7f..c174c945 100644
> > > --- a/Documentation/meson.build
> > > +++ b/Documentation/meson.build
> > > @@ -31,6 +31,7 @@ if doxygen.found() and dot.found()
> > >                        libcamera_sources,
> > >                        libipa_headers,
> > >                        libipa_sources,
> > > +                      ipu3_ipa_sources,
> > 
> > Same.
> > 
> > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > 
> > >                    ],
> > >                    output : 'api-html',
> > >                    command : [doxygen, doxyfile],
Kieran Bingham Oct. 25, 2021, 10:03 p.m. UTC | #4 
Quoting Laurent Pinchart (2021-10-25 22:59:32)
> On Mon, Oct 25, 2021 at 10:56:54PM +0100, Kieran Bingham wrote:
> > Quoting Laurent Pinchart (2021-10-25 22:44:54)
> > > Hi Jean-Michel and Kieran,
> > > 
> > > Thank you for the patch.
> > > 
> > > On Fri, Oct 22, 2021 at 05:12:18PM +0200, Jean-Michel Hautbois wrote:
> > > > From: Kieran Bingham <kieran.bingham@ideasonboard.com>
> > > 
> > > Now we have a From: line :-)
> > > 
> > > > The IPU3 is documented using Doxygen within the code.
> > > > 
> > > > Include the IPU3 IPA as part of the doxygen build sources. This will
> > > > ideally be split to it's own 'section' of the doxygen output.
> > > 
> > > s/it's/its/
> > 
> > I bet you'd know /it's/ from me with that in there anyway ;-)
> > It's always me when it's it's isn't it's.
> > 
> > > 
> > > > Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> > 
> > This should still have an SoB from anyone it goes through though, so as
> > it's gone through you JM, it needs your SoB. (Same for any others).
> 
> Not for the mere act of reposting the patch unmodified. An SoB should be
> added when the poster modifies the patch, or when a committer commits
> the patch to a git tree.

Ok, I thought it was required if it went 'through' a route like that.

Anyway, if the modifications are made below, that will become true. But
agreed on this version.


> 
> > > > ---
> > > >  Documentation/Doxyfile.in | 1 +
> > > >  Documentation/meson.build | 1 +
> > > >  2 files changed, 2 insertions(+)
> > > > 
> > > > diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> > > > index 6e627192..37b231bc 100644
> > > > --- a/Documentation/Doxyfile.in
> > > > +++ b/Documentation/Doxyfile.in
> > > > @@ -790,6 +790,7 @@ WARN_LOGFILE           =
> > > >  
> > > >  INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
> > > >                        "@TOP_SRCDIR@/src/ipa/libipa" \
> > > > +                      "@TOP_SRCDIR@/src/ipa/ipu3" \
> > > 
> > > Alphabetical order.
> > > 
> > > >                        "@TOP_SRCDIR@/src/libcamera" \
> > > >                        "@TOP_BUILDDIR@/include/libcamera" \
> > > >                        "@TOP_BUILDDIR@/src/libcamera"
> > > > diff --git a/Documentation/meson.build b/Documentation/meson.build
> > > > index c4bd3c7f..c174c945 100644
> > > > --- a/Documentation/meson.build
> > > > +++ b/Documentation/meson.build
> > > > @@ -31,6 +31,7 @@ if doxygen.found() and dot.found()
> > > >                        libcamera_sources,
> > > >                        libipa_headers,
> > > >                        libipa_sources,
> > > > +                      ipu3_ipa_sources,
> > > 
> > > Same.
> > > 
> > > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > > 
> > > >                    ],
> > > >                    output : 'api-html',
> > > >                    command : [doxygen, doxyfile],
> 
> -- 
> Regards,
> 
> Laurent Pinchart

Patch
diff mbox series 

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index 6e627192..37b231bc 100644
--- a/Documentation/Doxyfile.in
+++ b/Documentation/Doxyfile.in
@@ -790,6 +790,7 @@  WARN_LOGFILE           =
 
 INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
 			 "@TOP_SRCDIR@/src/ipa/libipa" \
+			 "@TOP_SRCDIR@/src/ipa/ipu3" \
 			 "@TOP_SRCDIR@/src/libcamera" \
 			 "@TOP_BUILDDIR@/include/libcamera" \
 			 "@TOP_BUILDDIR@/src/libcamera"
diff --git a/Documentation/meson.build b/Documentation/meson.build
index c4bd3c7f..c174c945 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -31,6 +31,7 @@  if doxygen.found() and dot.found()
                       libcamera_sources,
                       libipa_headers,
                       libipa_sources,
+                      ipu3_ipa_sources,
                   ],
                   output : 'api-html',
                   command : [doxygen, doxyfile],