Re: [PATCH 4/4] bitbake-setup: implement symlinking local sources into builds

[Paul Barker <paul@pbarker.dev>]

[-- Attachment #1: Type: text/plain, Size: 2909 bytes --]

On Thu, 2025-12-11 at 15:25 +0100, Alexander Kanavin wrote:
> From: Alexander Kanavin <alex@linutronix.de>
> 
> The feature and the use case were proposed here:
> https://lists.openembedded.org/g/bitbake-devel/message/18373
> 
> The implementation extends the schema with a 'local' source type,
> and simply symlinks them into the setup directory during 'init'.
> 'status' or 'update' do not consider or modify the symlinks.
> 
> The overrides support is extended to add a command line 'shortcut'
> for overriding sources with a local path, and massaging relative or
> ~-containing paths as appropriate.
> 
> Documentation is extended to describe the local sources and show
> examples. The json properties for sources are also grouped correctly to show
> what is git-specific, what is local-specific and what is common.
> 
> Tests are extended to cover a few things that weren't previously tested:
> source overrides, custom setup directory names, and tests for local
> sources are added as well.
> 
> Signed-off-by: Alexander Kanavin <alex@linutronix.de>
> ---
>  bin/bitbake-setup                             | 29 ++++++++++-
>  .../bitbake-user-manual-environment-setup.rst | 50 +++++++++++++++++--
>  lib/bb/tests/setup.py                         | 28 +++++++++++
>  setup-schema/layers.schema.json               | 14 ++++++
>  4 files changed, 115 insertions(+), 6 deletions(-)
> 
> diff --git a/bin/bitbake-setup b/bin/bitbake-setup
> index 1f83b1b2a..30c5c44f7 100755
> --- a/bin/bitbake-setup
> +++ b/bin/bitbake-setup
> @@ -109,6 +109,10 @@ def checkout_layers(layers, layerdir, d):
>              revision = urldata.revision
>              layers_fixed_revisions[r_name]['git-remote']['rev'] = revision
>  
> +    def _symlink_local(src, dst):
> +        print("Making a symbolic link {} pointing to {}".format(dst, src))
> +        os.symlink(src, dst)
> +
>      layers_fixed_revisions = copy.deepcopy(layers)
>      repodirs = []
>      oesetupbuild = None
> @@ -121,6 +125,9 @@ def checkout_layers(layers, layerdir, d):
>          r_remote = r_data.get('git-remote')
>          if r_remote:
>              _checkout_git_remote(r_remote, repodir, layers_fixed_revisions)
> +        local = r_data.get('local')
> +        if local:
> +            _symlink_local(os.path.expanduser(local["path"]), os.path.join(layerdir,repodir))

Applying overrides shouldn't result in both 'git-remote' and 'local'
keys being present for the same source, but a badly written .conf.json
file could contain both. We should probably error out if both keys are
provided.

We call os.path.expanduser() in obtain_overrides, so I don't think we
need to call it again here.

And, I'd prefer the variable name r_local to match r_remote.

The rest of this looks great and works well in my local testing. Thanks
for implementing this!

-- 
Paul Barker



[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 252 bytes --]