[libcamera-devel,2/2] libcamera: Document dependencies for IPA module signing

Message ID 20200415193719.783-2-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • [libcamera-devel,1/2] libcamera: Make IPA module signing optional
Related show

Commit Message

Laurent Pinchart April 15, 2020, 7:37 p.m. UTC
Document the dependency on libgnutls28-dev and openssl for IPA module
signing int he README.rst file. While at it, sort the entries
alphabetically.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 README.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

Comments

Kieran Bingham April 16, 2020, 11:46 a.m. UTC | #1
Hi Laurent,

On 15/04/2020 20:37, Laurent Pinchart wrote:
> Document the dependency on libgnutls28-dev and openssl for IPA module
> signing int he README.rst file. While at it, sort the entries
> alphabetically.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  README.rst | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/README.rst b/README.rst
> index 656fdbfdc94c..da3cc64966b0 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -60,15 +60,18 @@ for libcamera: [required]
>  for device hotplug enumeration: [optional]
>  	pkg-config libudev-dev
>  
> -for qcam: [optional]
> -	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
> -
>  for documentation: [optional]
>  	python3-sphinx doxygen
>  
>  for gstreamer: [optional]
>  	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
>  
> +for IPA module signing: [optional]
> +        libgnutls28-dev openssl

Hrmm... Currently this is not [optional], but [required], as the
resulting code paths which get executed otherwise are non-functional :-[

Can we make this [required] until the IPAProxyLinux is implemented
correctly?

Otherwise - the user is presented with completely un-obvious segfaults
on the EventNotifier destructor when it perhaps incorrectly obtains an
invalid EventDispatcher *1


*1: Not fully investigated.

--
Kieran



> +
> +for qcam: [optional]
> +	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
> +
>  Using GStreamer plugin
>  ~~~~~~~~~~~~~~~~~~~~~~
>  
>
Laurent Pinchart April 16, 2020, 11:51 a.m. UTC | #2
Hi Kieran,

On Thu, Apr 16, 2020 at 12:46:17PM +0100, Kieran Bingham wrote:
> On 15/04/2020 20:37, Laurent Pinchart wrote:
> > Document the dependency on libgnutls28-dev and openssl for IPA module
> > signing int he README.rst file. While at it, sort the entries
> > alphabetically.
> > 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> >  README.rst | 9 ++++++---
> >  1 file changed, 6 insertions(+), 3 deletions(-)
> > 
> > diff --git a/README.rst b/README.rst
> > index 656fdbfdc94c..da3cc64966b0 100644
> > --- a/README.rst
> > +++ b/README.rst
> > @@ -60,15 +60,18 @@ for libcamera: [required]
> >  for device hotplug enumeration: [optional]
> >  	pkg-config libudev-dev
> >  
> > -for qcam: [optional]
> > -	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
> > -
> >  for documentation: [optional]
> >  	python3-sphinx doxygen
> >  
> >  for gstreamer: [optional]
> >  	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
> >  
> > +for IPA module signing: [optional]
> > +        libgnutls28-dev openssl
> 
> Hrmm... Currently this is not [optional], but [required], as the
> resulting code paths which get executed otherwise are non-functional :-[

Indeed, my bad :-(

> Can we make this [required] until the IPAProxyLinux is implemented
> correctly?

Sounds good to me. How about doing so on top of this patch, in a patch
that can then reverted when isolation support will be complete ?

> Otherwise - the user is presented with completely un-obvious segfaults
> on the EventNotifier destructor when it perhaps incorrectly obtains an
> invalid EventDispatcher *1
> 
> *1: Not fully investigated.
> 
> > +
> > +for qcam: [optional]
> > +	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
> > +
> >  Using GStreamer plugin
> >  ~~~~~~~~~~~~~~~~~~~~~~
> >
Kieran Bingham April 16, 2020, 12:18 p.m. UTC | #3
Hi Laurent,

On 15/04/2020 20:37, Laurent Pinchart wrote:
> Document the dependency on libgnutls28-dev and openssl for IPA module
> signing int he README.rst file. While at it, sort the entries
> alphabetically.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

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

> ---
>  README.rst | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/README.rst b/README.rst
> index 656fdbfdc94c..da3cc64966b0 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -60,15 +60,18 @@ for libcamera: [required]
>  for device hotplug enumeration: [optional]
>  	pkg-config libudev-dev
>  
> -for qcam: [optional]
> -	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
> -
>  for documentation: [optional]
>  	python3-sphinx doxygen
>  
>  for gstreamer: [optional]
>  	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
>  
> +for IPA module signing: [optional]
> +        libgnutls28-dev openssl
> +
> +for qcam: [optional]
> +	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
> +
>  Using GStreamer plugin
>  ~~~~~~~~~~~~~~~~~~~~~~
>  
>

Patch

diff --git a/README.rst b/README.rst
index 656fdbfdc94c..da3cc64966b0 100644
--- a/README.rst
+++ b/README.rst
@@ -60,15 +60,18 @@  for libcamera: [required]
 for device hotplug enumeration: [optional]
 	pkg-config libudev-dev
 
-for qcam: [optional]
-	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
-
 for documentation: [optional]
 	python3-sphinx doxygen
 
 for gstreamer: [optional]
 	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
 
+for IPA module signing: [optional]
+        libgnutls28-dev openssl
+
+for qcam: [optional]
+	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5
+
 Using GStreamer plugin
 ~~~~~~~~~~~~~~~~~~~~~~