Re: [OE-core] [PATCH] vscode: improve settings for new yocto plugin

[adrian.freihofer@gmail.com]

On Fri, 2024-02-09 at 23:43 +0000, Richard Purdie wrote:
> On Fri, 2024-02-09 at 21:30 +0100, Adrian Freihofer wrote:
> > There is a new official bitbake plugin:
> > https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake
> > 
> > This plugin automatically updates the .vscode/settings.json file.
> > 
> > Having the settings.json file in git and a plugin which modifies
> > this
> > file is not ideal. It can lead to anoying situations especially
> > when
> > working with git. For example a git stash reverts the settings
> > which are
> > automatically applied by the plugin. While git stashed the
> > settings.json
> > file the plugin immediately changes the file again and tries to run
> > bitbake based on the newly generated settings. When git does a
> > stash pop
> > the restored settings.json file conflicts with the new
> > settigns.json
> > file which has been generated while the git stash took place.
> > 
> > Removing the settings.json from git would lead to other issues as
> > already described in the commit message of 5ff688fe29. Until VSCode
> > or
> > the plugin supports multiple config files like bitbake does with
> > the
> > site.conf and the local.conf files, there are probably some use
> > cases
> > and workflows where the plugin needs to be disabled.
> > 
> > This commit aligns the default settings.json file with the default
> > settings.json which gets generated by the plugin. This is a
> > workaround
> > for the issue described above. But it works only for the default
> > build
> > configuration with one build folder named "build".
> > 
> > Discussion is here:
> > https://github.com/yoctoproject/vscode-bitbake/issues/95
> > ---
> >  .gitignore            |  4 ++--
> >  .vscode/settings.json | 28 +++++++++++++++++++++++++++-
> >  2 files changed, 29 insertions(+), 3 deletions(-)
> 
> I am very worried about this as we can't mandate a layout. There are
> many people who use different locations for bitbake and others who
> use
> different directories for builds. Even our own test runs do change
> the
> build directories.
> 
> I don't think we can solve this like this unfortunately.
> 
> Can we inject something into build directories when we create them?
> 

Here are some patches:
https://git.yoctoproject.org/poky-contrib/log/?h=adrianf/vscode-yocto-plugin

I will send them as V2 after I have tested them some more. (There are
already oe-selftest)

@Enguerrand your review would be appreciated.

Regards,
Adrian

> Cheers,
> 
> Richard