Re: [bitbake-devel] [PATCH v2 2/9] bitbake-setup.schema.json: Add examples property

"Yoann Congal" <[email protected]> Thu, 28 May 2026 12:48:19 +0200
Newsgroups org.openembedded.lists.bitbake-devel
Message-ID <[email protected]>
On Tue Apr 7, 2026 at 5:02 PM CEST, Rob Woolley via lists.openembedded.org wrote:
> This resolves the jsonschema linting error:
>     Set a non-empty examples array at the top level of the schema
>     to illustrate the expected data (top_level_examples)
>
> This example intentionally only references bitbake as a minimal
> example that focuses on the tool itself.
>
> Signed-off-by: Rob Woolley <[email protected]>
> ---
>  setup-schema/bitbake-setup.schema.json | 27 ++++++++++++++++++++++++++
>  1 file changed, 27 insertions(+)
>
> diff --git a/setup-schema/bitbake-setup.schema.json b/setup-schema/bitbake-setup.schema.json
> index d340c9785..3324546de 100644
> --- a/setup-schema/bitbake-setup.schema.json
> +++ b/setup-schema/bitbake-setup.schema.json
> @@ -1,6 +1,33 @@
>  {
>      "$schema": "https://json-schema.org/draft/2020-12/schema",
>      "description": "Schema for bitbake-setup configuration files",
> +    "examples" : [
> +        {
> +            "description": "Example bitbake-setup configuration file",
> +            "sources": {
> +                "bitbake": {
> +                    "git-remote": {
> +                        "remotes": {
> +                            "origin": {
> +                                "uri": "https://git.openembedded.org/bitbake"
> +                            }
> +                        },
> +                        "branch": "master",
> +                        "rev": "master"
> +                    },
> +                    "path": "bitbake"

For this example, I think we can use the shortest form:
  "sources": {
      "bitbake": {
          "git-remote": {
              "uri": "https://git.openembedded.org/bitbake",
              "rev": "master"
  		}
  }


> +                }
> +            },
> +            "bitbake-setup": {
> +                "configurations": [
> +                    {
> +                        "bb-layers": ["openembedded-core/meta","meta-yocto/meta-yocto-bsp","meta-yocto/meta-poky"]

The fact that this example references layer that it does not source
makes me uneasy.

How about a minimal example with bitbake+openembedded-core and a
qemux86-64+nodistro build?

> +                    }
> +                ]
> +            },
> +            "version": "1.0"
> +        }
> +    ],
>      "title": "bitbake-setup configuration file",
>      "type": "object",
>      "required": [


-- 
Yoann Congal
Smile ECS