[libcamera-devel,v2,01/11] README: Unify dependency names

Message ID 20200924071922.231063-2-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
All the dependencies are for libcamera, so we should move all the
packages under this paragraph, or make a paragraph for Meson, and a
second one for python3-yaml. I think the later is more clear.

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

Comments

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

Thank you for the patch.

On Thu, Sep 24, 2020 at 09:19:12AM +0200, Ricardo Ribalda wrote:
> All the dependencies are for libcamera, so we should move all the
> packages under this paragraph, or make a paragraph for Meson, and a
> second one for python3-yaml. I think the later is more clear.
>
> Signed-off-by: Ricardo Ribalda <ricardo@ribalda.com>
> ---
>  README.rst | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/README.rst b/README.rst
> index 40d4519..e756753 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -46,8 +46,8 @@ Other distributions may have differing package names:
>  A C++ toolchain: [required]
>  	Either {g++, clang}
>  
> -for libcamera: [required]
> -        meson (>= 0.47) ninja-build python3-yaml
> +Meson Build system: [required]
> +        meson (>= 0.47) ninja-build
>  
Wouldn't it be simpler to just group all the required dependencies for
the libcamera core in a single section ? Splitting them doesn't bring
that much value I think. Maybe just

for the libcamera core: [required]
        meson (>= 0.47) ninja-build python3-yaml

?

>          If your distribution doesn't provide a recent enough version of meson,
>          you can install or upgrade it using pip3.
> @@ -57,6 +57,9 @@ for libcamera: [required]
>              pip3 install --user meson
>              pip3 install --user --upgrade meson
>  
> +for generating the control definitions: [required]
> +        python3-yaml
> +
>  for device hotplug enumeration: [optional]
>  	pkg-config libudev-dev
>
Laurent Pinchart Sept. 24, 2020, 2:20 p.m. UTC | #2
On Thu, Sep 24, 2020 at 04:54:24PM +0300, Laurent Pinchart wrote:
> Hi Ricardo,
> 
> Thank you for the patch.
> 
> On Thu, Sep 24, 2020 at 09:19:12AM +0200, Ricardo Ribalda wrote:
> > All the dependencies are for libcamera, so we should move all the
> > packages under this paragraph, or make a paragraph for Meson, and a
> > second one for python3-yaml. I think the later is more clear.
> >
> > Signed-off-by: Ricardo Ribalda <ricardo@ribalda.com>
> > ---
> >  README.rst | 7 +++++--
> >  1 file changed, 5 insertions(+), 2 deletions(-)
> > 
> > diff --git a/README.rst b/README.rst
> > index 40d4519..e756753 100644
> > --- a/README.rst
> > +++ b/README.rst
> > @@ -46,8 +46,8 @@ Other distributions may have differing package names:
> >  A C++ toolchain: [required]
> >  	Either {g++, clang}
> >  
> > -for libcamera: [required]
> > -        meson (>= 0.47) ninja-build python3-yaml
> > +Meson Build system: [required]
> > +        meson (>= 0.47) ninja-build
> >  
> Wouldn't it be simpler to just group all the required dependencies for
> the libcamera core in a single section ? Splitting them doesn't bring
> that much value I think. Maybe just
> 
> for the libcamera core: [required]
>         meson (>= 0.47) ninja-build python3-yaml
> 
> ?

Now that I re-read this, I think we can also go with your patch as meson
can be considered in the same category as the C++ toolchain.

> >          If your distribution doesn't provide a recent enough version of meson,
> >          you can install or upgrade it using pip3.
> > @@ -57,6 +57,9 @@ for libcamera: [required]
> >              pip3 install --user meson
> >              pip3 install --user --upgrade meson
> >  
> > +for generating the control definitions: [required]

I would however name this "for the libcamra core" as I expect we'll add
more dependencies there.

Could you let me know of your preferred option through a v2.1 of just
this patch ?

> > +        python3-yaml
> > +
> >  for device hotplug enumeration: [optional]
> >  	pkg-config libudev-dev
> >

Patch

diff --git a/README.rst b/README.rst
index 40d4519..e756753 100644
--- a/README.rst
+++ b/README.rst
@@ -46,8 +46,8 @@  Other distributions may have differing package names:
 A C++ toolchain: [required]
 	Either {g++, clang}
 
-for libcamera: [required]
-        meson (>= 0.47) ninja-build python3-yaml
+Meson Build system: [required]
+        meson (>= 0.47) ninja-build
 
         If your distribution doesn't provide a recent enough version of meson,
         you can install or upgrade it using pip3.
@@ -57,6 +57,9 @@  for libcamera: [required]
             pip3 install --user meson
             pip3 install --user --upgrade meson
 
+for generating the control definitions: [required]
+        python3-yaml
+
 for device hotplug enumeration: [optional]
 	pkg-config libudev-dev