Openembedded Core Discussions
 help / color / mirror / Atom feed
From: Richard Purdie <richard.purdie@linuxfoundation.org>
To: Alexander Kanavin <alex.kanavin@gmail.com>
Cc: openembedded-core@lists.openembedded.org,
	Alexander Kanavin <alex@linutronix.de>
Subject: Re: [OE-core] [PATCH 2/2] oe-setup-build: add a tool for discovering config templates and setting up builds
Date: Mon, 31 Jul 2023 13:04:41 +0100	[thread overview]
Message-ID: <2039c55f7149d1a362e324751626fc2f032cdec2.camel@linuxfoundation.org> (raw)
In-Reply-To: <CANNYZj95L_pLLeL_-bUrMLSAVaG0NgSWBSNnpF9KjK5wpXYA-A@mail.gmail.com>

On Mon, 2023-07-31 at 13:31 +0200, Alexander Kanavin wrote:
> On Mon, 31 Jul 2023 at 12:56, Richard Purdie <rpurdie@rpsys.net> wrote:
> 
> > I've just been looking at this again and I'm still not convinced this
> > is right. In particular, the above output worries me a lot, partly as I
> > barely understand it and I suspect if I struggle, I won't be the only
> > one.
> > 
> > With this kind of core tool, the "interface" to the user needs to be
> > really clear and the problem here is that it isn't.
> > 
> > Being more specific, from the above it is listing some commands I could
> > run, but the user is being left to work out what the difference is for
> > themselves. If I print a list like:
> > 
> > a) poky default
> > b) gizmo config
> > c) gadget config
> > 
> > then ask the user to select one, it is clear as the user is drawn to
> > the key information. In the above text output, you have to know where
> > to look in the commands to guess the pieces.
> > 
> > The "/srv/work/alex" string is confusing the output and in many ways
> > even filtering that out would help reduce the "superfluous" text but
> > the issue does run deeper than that.
> > 
> > As another example, perhaps I shouldn't need the -v to get at least
> > some summary of what each one does?
> 
> Thanks, I'm glad this wasn't forgotten (or quietly shelved :). I kinda
> announced in my EOSS talk that there should be a nicer way for
> newcomers to set up builds than oe-init-build-env and that we're
> working on it.
> 
> For no reason at all I was trying to avoid adding an interactive mode
> :), but prompting users to make a selection will make things a lot
> smoother. And each configuration should have a stable and sweet
> shortcut name (at least, within a specific layer checkout), so that
> awkward full paths are completely avoided. Maybe
> {template-directory-name}-{layer-name}. I.e. 'default-meta-poky' or
> 'gizmo-meta-alex'.

Just to be clear I'm not saying it needs to be interactive but that we
need to think carefully about how the information is presented so that
it is easy to understand.

You could think about using the layer name in these contexts as layers
should be defining them at this point?

Yes, getting the layer name means parsing but we can likely handle that
at this point as we're in python.

> Also, content of conf-notes.txt in oe-core/poky should be moved to the
> first-time banner in scripts/oe-setup-builddir, and the files should
> only point out that "This template sets up a default build
> configuration used by Poky reference distribution" or similar.
> Otherwise the tool will print what these files have now, which is not
> helpful.
> 
> Should we be fine with just conf-notes.txt containing the template
> description as a freeform plaintext, or is there a use case for more
> structured template metadata?

Could/should it be a variable in layer.conf?

Cheers,

Richard






  reply	other threads:[~2023-07-31 12:04 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-10  9:57 [PATCH 1/2] scripts/oe-setup-layers: write a list of layer paths into the checkout's top dir Alexander Kanavin
2023-05-10  9:57 ` [PATCH 2/2] oe-setup-build: add a tool for discovering config templates and setting up builds Alexander Kanavin
2023-07-31 10:56   ` [OE-core] " Richard Purdie
2023-07-31 11:31     ` Alexander Kanavin
2023-07-31 12:04       ` Richard Purdie [this message]
2023-07-31 12:15         ` Alexander Kanavin
2023-07-31 12:42           ` Richard Purdie
2023-07-31 14:14             ` Alexander Kanavin
2023-07-31 14:23               ` Richard Purdie

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=2039c55f7149d1a362e324751626fc2f032cdec2.camel@linuxfoundation.org \
    --to=richard.purdie@linuxfoundation.org \
    --cc=alex.kanavin@gmail.com \
    --cc=alex@linutronix.de \
    --cc=openembedded-core@lists.openembedded.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox