[libcamera-devel,2/5] Documentation: application-developer: Clean up build instructions
diff mbox series

Message ID 20210825102937.3740405-3-kieran.bingham@ideasonboard.com
State Accepted
Headers show
Series
  • application-developer: Clean up
Related show

Commit Message

Kieran Bingham Aug. 25, 2021, 10:29 a.m. UTC
The build and run instructions read as if meson is the only way to
compile the application. Although this is recommended, it is not
required - adapt the language to fit better.

While here, fix the naming of the simple_cam meson object to match
the other usages of 'simple-cam'.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 Documentation/guides/application-developer.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Laurent Pinchart Aug. 25, 2021, 7:27 p.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Wed, Aug 25, 2021 at 11:29:34AM +0100, Kieran Bingham wrote:
> The build and run instructions read as if meson is the only way to
> compile the application. Although this is recommended, it is not
> required - adapt the language to fit better.
> 
> While here, fix the naming of the simple_cam meson object to match
> the other usages of 'simple-cam'.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

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

> ---
>  Documentation/guides/application-developer.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst
> index b79241bd9317..442d8e6a512e 100644
> --- a/Documentation/guides/application-developer.rst
> +++ b/Documentation/guides/application-developer.rst
> @@ -563,8 +563,8 @@ uses, so needs to do the following:
>  Build and run instructions
>  --------------------------
>  
> -To build the application, use the `Meson build system`_ which is also the
> -official build system of the libcamera library.
> +To build the application, we recommend that you use the `Meson build system`_
> +which is also the official build system of the libcamera library.
>  
>  Make sure both ``meson`` and ``libcamera`` are installed in your system. Please
>  refer to your distribution documentation to install meson and install the most
> @@ -617,7 +617,7 @@ accordingly. In this example, the application file has been named
>  
>     project('simple-cam', 'cpp')
>  
> -   simpler_cam = executable('simple-cam',
> +   simple_cam = executable('simple-cam',
>         'simple-cam.cpp',
>         dependencies: dependency('libcamera', required : true))
>

Patch
diff mbox series

diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst
index b79241bd9317..442d8e6a512e 100644
--- a/Documentation/guides/application-developer.rst
+++ b/Documentation/guides/application-developer.rst
@@ -563,8 +563,8 @@  uses, so needs to do the following:
 Build and run instructions
 --------------------------
 
-To build the application, use the `Meson build system`_ which is also the
-official build system of the libcamera library.
+To build the application, we recommend that you use the `Meson build system`_
+which is also the official build system of the libcamera library.
 
 Make sure both ``meson`` and ``libcamera`` are installed in your system. Please
 refer to your distribution documentation to install meson and install the most
@@ -617,7 +617,7 @@  accordingly. In this example, the application file has been named
 
    project('simple-cam', 'cpp')
 
-   simpler_cam = executable('simple-cam',
+   simple_cam = executable('simple-cam',
        'simple-cam.cpp',
        dependencies: dependency('libcamera', required : true))