[libcamera-devel,v2,03/11] README: Add libboost to list of dependencies

Message ID 20200924071922.231063-4-ricardo@ribalda.com
State Accepted
Headers show
Series
  • Fix README.rst
Related show

Commit Message

Ricardo Ribalda Sept. 24, 2020, 7:19 a.m. UTC
RPi IPA, which is enabled by default, requires libboost to compile.
Specify in the documentation its dependencies and how to disable the
IPA.

Signed-off-by: Ricardo Ribalda <ricardo@ribalda.com>
---
 README.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Laurent Pinchart Sept. 24, 2020, 1:59 p.m. UTC | #1
Hi Ricardo,

Thank you for the patch.

On Thu, Sep 24, 2020 at 09:19:14AM +0200, Ricardo Ribalda wrote:
> RPi IPA, which is enabled by default, requires libboost to compile.
> Specify in the documentation its dependencies and how to disable the
> IPA.
> 
> Signed-off-by: Ricardo Ribalda <ricardo@ribalda.com>
> ---
>  README.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/README.rst b/README.rst
> index 5059ce9..46efff3 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -63,6 +63,15 @@ for generating the control definitions: [required]
>  for IPA module signing: [required]
>          libgnutls28-dev openssl
>  
> +for building the RPi IPA: [optional]

Rapsberry Pi usually prefer spelling it in full, I'd write "Raspberry Pi
IPA". And also s/building // as it's all for the purpose of building
libcamera :-)

> +        libboost-dev
> +
> +        If you decide to not build the RPi IP, you should configure meson this way:

s/RPi IP/Raspberry Pi IPA/

This is useful but a bit tricky, as we would have to expand this list
when we add new pipeline handlers (and you're already missing the simple
pipeline handler :-)). How about just stating

	Support for Raspberry Pi can be disabled through the meson
	'pipelines' option to avoid this dependency.

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

> +
> +        .. code::
> +
> +            -Dpipelines=vimc,uvcvideo,ipu3,rkisp1
> +
>  for device hotplug enumeration: [optional]
>  	pkg-config libudev-dev
>

Patch

diff --git a/README.rst b/README.rst
index 5059ce9..46efff3 100644
--- a/README.rst
+++ b/README.rst
@@ -63,6 +63,15 @@  for generating the control definitions: [required]
 for IPA module signing: [required]
         libgnutls28-dev openssl
 
+for building the RPi IPA: [optional]
+        libboost-dev
+
+        If you decide to not build the RPi IP, you should configure meson this way:
+
+        .. code::
+
+            -Dpipelines=vimc,uvcvideo,ipu3,rkisp1
+
 for device hotplug enumeration: [optional]
 	pkg-config libudev-dev