Re: [bitbake-devel] [PATCH 2/2] bitbake-setup: write notes for generated build configs

On Mon, 1 Jun 2026 at 15:55, Ernest Van Hoecke
<[email protected]> wrote:
> I considered this and agree, there's no true beautiful solution here.
> The description field also has this issue, granted, that's meant to be
> much shorter than notes.
>
> Since json doesn't support multiline strings, the only alternative is
> making this field a list of strings and concatenating them in code. I'm
> certainly open to that and can send a v2 doing it that way (it'd look
> like an extra "\n".join()).

Yes. We're basically restricted by json's original purpose of being a
data transfer format, and not a config file format. (the "no comments"
restriction is in the same vein). It's a lot more human friendly than
xml, but still not friendly enough, by modern standards.

It's tempting to make it a reference to an external file, but this
wouldn't work well when the config is fetched with http:
$ bitbake-setup init https://my.server/some-build.conf.json
would have to also fetch the notes file.

A list of strings isn't horrible, perhaps either can be supported?

Alex