[libcamera-devel,2/4] meson: options: Document the options

Message ID 20190322104350.31091-3-kieran.bingham@ideasonboard.com
State Superseded
Headers show
Series
  • Cleanup and non-GNU C library support
Related show

Commit Message

Kieran Bingham March 22, 2019, 10:43 a.m. UTC
Re-order the project options and add documentation which will be
presented by 'meson configure'.

This produces the following extra information:

Project options:
  Option        Current Value Possible Values Description
  ------        ------------- --------------- -----------
  documentation true          [true, false]   Generate the project documentation
  tests         true          [true, false]   Compile and include the tests

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 meson_options.txt | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

Comments

Laurent Pinchart March 22, 2019, 11 p.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Fri, Mar 22, 2019 at 10:43:48AM +0000, Kieran Bingham wrote:
> Re-order the project options and add documentation which will be
> presented by 'meson configure'.
> 
> This produces the following extra information:
> 
> Project options:
>   Option        Current Value Possible Values Description
>   ------        ------------- --------------- -----------
>   documentation true          [true, false]   Generate the project documentation
>   tests         true          [true, false]   Compile and include the tests
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

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

> ---
>  meson_options.txt | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/meson_options.txt b/meson_options.txt
> index c5df661a2286..97efc85b4412 100644
> --- a/meson_options.txt
> +++ b/meson_options.txt
> @@ -1,2 +1,7 @@
> -option('tests', type : 'boolean')
> -option('documentation', type : 'boolean')
> +option('documentation',
> +        type : 'boolean',
> +        description : 'Generate the project documentation')
> +
> +option('tests',
> +        type : 'boolean',
> +        description: 'Compile and include the tests')

Patch

diff --git a/meson_options.txt b/meson_options.txt
index c5df661a2286..97efc85b4412 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -1,2 +1,7 @@ 
-option('tests', type : 'boolean')
-option('documentation', type : 'boolean')
+option('documentation',
+        type : 'boolean',
+        description : 'Generate the project documentation')
+
+option('tests',
+        type : 'boolean',
+        description: 'Compile and include the tests')