From: Alexander Kanavin <alex.kanavin@gmail.com>
To: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Cc: "poky@lists.yoctoproject.org" <poky@lists.yoctoproject.org>,
Alexander Kanavin <alex@linutronix.de>
Subject: Re: [poky] [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description
Date: Fri, 1 Sep 2023 11:24:04 +0200 [thread overview]
Message-ID: <CANNYZj9Xj54_R_obhYuyU-U=KVPsk8XVPbR2ETKt9vPw8tuc3g@mail.gmail.com> (raw)
In-Reply-To: <DB5PR02MB1021351151153EC752FD400E2EFE5A@DB5PR02MB10213.eurprd02.prod.outlook.com>
On Thu, 31 Aug 2023 at 21:10, Peter Kjellerstedt
<peter.kjellerstedt@axis.com> wrote:
> > conf-notes.txt would contain lengthy instructions/notes for how to use
> > the template and would be shown when you actually set up a build
> > directory (this is already happening now), conf-description.txt has a
> > single sentence saying what it is for, and shown before/during
> > selection of the template.
> Well, your distinction between "notes" and "description" and that the
> latter is expected to be a oneliner is not obvious from their names.
> Though, in the end, I guess it is all down to documentation...
There's also how the tools are handling them. 'bitbake-layers
save-build-conf' would write the following into the files:
https://patchwork.yoctoproject.org/project/oe-core/patch/20230830154314.661141-1-alex@linutronix.de/
Description would be then shown on template selection and both
description and notes when initializing a build from it. Between all
that users should be able to figure out what needs to go where.
Alex
prev parent reply other threads:[~2023-09-01 9:24 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-30 14:15 [PATCH 1/2] meta/conf/templates/default/conf-notes.txt: remove Alexander Kanavin
2023-08-30 14:15 ` [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description Alexander Kanavin
2023-08-31 17:03 ` [poky] " Peter Kjellerstedt
2023-08-31 17:11 ` Alexander Kanavin
2023-08-31 19:10 ` Peter Kjellerstedt
2023-09-01 9:24 ` Alexander Kanavin [this message]
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='CANNYZj9Xj54_R_obhYuyU-U=KVPsk8XVPbR2ETKt9vPw8tuc3g@mail.gmail.com' \
--to=alex.kanavin@gmail.com \
--cc=alex@linutronix.de \
--cc=peter.kjellerstedt@axis.com \
--cc=poky@lists.yoctoproject.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).